Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix some doxygen errors
[simgrid.git] / src / kernel / lmm / System.hpp
index a0505ce9f57975c1a1fb4ce30ee83ba91060645f..25fa550730fee8ed3d4500064a37f6074e449b9c 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2022. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2023. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -8,10 +8,7 @@
 
 #include "simgrid/kernel/resource/Action.hpp"
 #include "simgrid/kernel/resource/Model.hpp"
-#include "simgrid/s4u/Link.hpp"
-#include "src/surf/surf_interface.hpp"
 #include "xbt/asserts.h"
-#include "xbt/ex.h"
 #include "xbt/mallocator.h"
 
 #include <boost/intrusive/list.hpp>
 #include <string_view>
 #include <vector>
 
+/* user-visible parameters */
+XBT_PUBLIC_DATA double sg_precision_workamount;
+XBT_PUBLIC_DATA double sg_precision_timing;
+XBT_PUBLIC_DATA int sg_concurrency_limit;
+
 namespace simgrid::kernel::lmm {
 
-/** @addtogroup SURF_lmm
+/** @addtogroup Model_lmm
  * @details
  * A linear maxmin solver to resolve inequations systems.
  *
@@ -133,7 +135,7 @@ namespace simgrid::kernel::lmm {
  * At the current state, each variable counts as 1 if its consumption weight is greater than 1.
  */
 
-/** @{ @ingroup SURF_lmm */
+/** @{ @ingroup Model_lmm */
 
 /**
  * @brief LMM element
@@ -206,7 +208,7 @@ public:
  */
 class XBT_PUBLIC Constraint {
 public:
-  enum class SharingPolicy { NONLINEAR = 2, SHARED = 1, FATPIPE = 0 };
+  enum class SharingPolicy { WIFI = 3, NONLINEAR = 2, SHARED = 1, FATPIPE = 0 };
 
   Constraint(resource::Resource* id_value, double bound_value);
 
@@ -218,8 +220,8 @@ public:
   /** @brief Check how a constraint is shared  */
   SharingPolicy get_sharing_policy() const { return sharing_policy_; }
 
-  /** @brief Get the usage of the constraint after the last lmm solve */
-  double get_usage() const;
+  /** @brief Get the load of the constraint after the last lmm solve */
+  double get_load() const;
 
   /** @brief Sets the concurrency limit for this constraint */
   void set_concurrency_limit(int limit)
@@ -243,7 +245,7 @@ public:
   int get_concurrency_maximum() const
   {
     xbt_assert(concurrency_limit_ < 0 || concurrency_maximum_ <= concurrency_limit_,
-               "Very bad: maximum observed concurrency is higher than limit. This is a bug of SURF, please report it.");
+               "Very bad: maximum observed concurrency is higher than limit. This is a bug, please report it.");
     return concurrency_maximum_;
   }