#include <gtopt/capacity_object_lp.hpp>
CapacityObjectLP struct
A linear programming representation of an object with capacity constraints.
| Template parameters | |
|---|---|
| Object | The type of object being modeled, must provide capacity-related attributes |
Base classes
-
template<typename ObjectType ObjectType>class ObjectLP<Object>
- Wrapper class that adds LP capabilities to objects.
- struct CapacityObjectBase
- Base class providing capacity constraint logic for LP objects.
Public types
- using Base = ObjectLP<Object>
- using CapacityAndCol = std::pair<std::optional<double>, std::optional<ColIndex>>
- Pair of optional capacity value and optional expansion column index.
- using object_type = Object
- Type of the wrapped object.
Public functions
- auto add_to_lp(SystemContext& sc, const ScenarioLP& scenario, const StageLP& stage, LinearProblem& lp) -> bool
- Add capacity constraints to the linear problem.
- auto add_to_output(OutputContext& out) const -> bool
- Add capacity solution data to output context.
- auto capacity_and_col(const StageLP& stage, LinearProblem& lp) const -> CapacityAndCol -> constexpr auto
- Query capacity value and optional expansion column for a stage.
-
auto capacity_at(const StageLP& stage,
const double def_capacity = std::numeric_limits<double>::
max()) const -> constexpr double - Get the capacity at a specific stage.
- auto capacity_col_at(const StageLP& stage) const -> constexpr auto noexcept
- Get the column index for capacity at a specific stage.
- auto CapacityObjectLP(ObjectT&& pobject, const InputContext& ic, const LPClassName cname) -> constexpr explicit
- Construct a new CapacityObjectLP object.
- auto class_name(this const Self& self) -> constexpr auto noexcept
- auto id() const -> constexpr const Id& noexcept
- auto id() const -> constexpr auto noexcept
- auto is_active(const StageLP& stage) const -> constexpr bool
- Checks if object is active in given stage.
- auto lp_col_label(this const Self& self, SystemContext& sc, const ScenarioLP& scenario, const StageLP& stage, Args && ... args) -> constexpr auto
- auto lp_col_label(this const Self& self, SystemContext& sc, const ScenarioLP& scenario, const StageLP& stage, const BlockLP& block, Args && ... args) -> constexpr auto
- auto lp_label(this const Self& self, SystemContext& sc, const ScenarioLP& scenario, const StageLP& stage, Args && ... args) -> constexpr auto
- auto lp_label(this const Self& self, SystemContext& sc, const ScenarioLP& scenario, const StageLP& stage, const BlockLP& block, Args && ... args) -> constexpr auto
- auto lp_label(this const Self& self, SystemContext& sc, const StageLP& stage, Args && ... args) -> constexpr auto
- auto object() && -> constexpr Object&& noexcept
- auto object() & -> constexpr Object& noexcept
- Gets the wrapped object.
- auto object() const && -> constexpr const Object&& noexcept
- auto object() const & -> constexpr const Object& noexcept
- auto set_id(Uid uid, Name name) -> constexpr auto& noexcept
- Sets the object's identifier.
- auto short_name(this const Self& self) -> constexpr auto noexcept
- auto state_col_label(this const Self& self, SystemContext& sc, const ScenarioLP& scenario, const StageLP& stage, Args && ... args) -> constexpr auto
- Generates a label for a variable in the optimization problem.
- auto state_col_label(this const Self& self, SystemContext& sc, const ScenarioLP& scenario, const StageLP& stage, const BlockLP& block, Args && ... args) -> constexpr auto
- auto sv_key(this const Self& self, const ScenarioLP& scenario, const StageLP& stage, std::string_view col_name) -> constexpr auto noexcept
- Generates a state variable key for the object.
- auto sv_key(this const Self& self, const StageLP& stage, std::string_view col_name) -> constexpr auto noexcept
- auto uid() const -> constexpr auto noexcept
- auto uid() const -> constexpr auto noexcept
Typedef documentation
#include <gtopt/object_lp.hpp>
using gtopt::
Type of the wrapped object.
Function documentation
bool gtopt::
Add capacity constraints to the linear problem.
| Parameters | |
|---|---|
| sc | System context providing stage/scenario info |
| scenario | Current scenario |
| stage | Current stage |
| lp | Linear problem to modify |
| Returns | true if successful, false otherwise |
Adds capacity-related variables and constraints:
- Capacity installation variables
- Capacity cost variables
- Expansion model variables (if applicable)
- Balance equations between stages
- Cost tracking equations
bool gtopt::
Add capacity solution data to output context.
| Parameters | |
|---|---|
| out | Output context to populate |
| Returns | true if successful, false otherwise |
Adds:
- Solution values for capacity variables
- Cost values for capacity variables
- Dual values for capacity constraints
constexpr auto gtopt::
Query capacity value and optional expansion column for a stage.
| Parameters | |
|---|---|
| stage | The stage to query |
| lp | Linear problem reference (needed for expansion col bounds) |
Returns {std::optional<double>, std::optional<ColIndex>}. The capacity is nullopt when no expansion column exists AND no capacity schedule value is defined — i.e. when the physical capacity is truly undefined. Callers that need a numeric fallback should use value_or(default) on the returned optional.
constexpr gtopt::
Construct a new CapacityObjectLP object.
| Template parameters | |
|---|---|
| ObjectT | Type of object being wrapped (deduced) |
| Parameters | |
| pobject | The object to wrap, will be moved if rvalue |
| ic | Input context providing stage/scenario information |
| cname | Class name for labeling columns/rows |
Initializes all capacity-related schedules from the wrapped object:
- Base capacity
- Expansion capacity
- Maximum capacity
- Expansion model
- Annual capacity costs
- Annual derating factors
#include <gtopt/object_lp.hpp>
constexpr auto gtopt::
#include <gtopt/object_utils.hpp>
template<typename Object Object>
template<typename Self Self, typename SystemContext SystemContext, typename... Args>
constexpr auto gtopt::
#include <gtopt/object_utils.hpp>
template<typename Object Object>
template<typename Self Self, typename SystemContext SystemContext, typename... Args>
constexpr auto gtopt::
#include <gtopt/object_utils.hpp>
template<typename Object Object>
template<typename Self Self, typename SystemContext SystemContext, typename... Args>
constexpr auto gtopt::
#include <gtopt/object_utils.hpp>
template<typename Object Object>
template<typename Self Self, typename SystemContext SystemContext, typename... Args>
constexpr auto gtopt::
#include <gtopt/object_lp.hpp>
constexpr auto gtopt::
#include <gtopt/object_utils.hpp>
template<typename Object Object>
template<typename Self Self, typename SystemContext SystemContext, typename... Args>
constexpr auto gtopt::
Generates a label for a variable in the optimization problem.
| Parameters | |
|---|---|
| self | Reference to the object |
| sc | System context |
| scenario | Scenario context |
| stage | Stage context |
| args | Additional arguments to include in the label |
| Returns | Label string |
#include <gtopt/object_utils.hpp>
template<typename Object Object>
template<typename Self Self, typename SystemContext SystemContext, typename... Args>
constexpr auto gtopt::
#include <gtopt/object_utils.hpp>
template<typename Object Object>
template<typename Self Self, typename ScenarioLP ScenarioLP, typename StageLP StageLP>
constexpr auto gtopt::
Generates a state variable key for the object.
| Parameters | |
|---|---|
| self | Reference to the object |
| scenario | Scenario context |
| stage | Stage context |
| col_name | The column name for the state variable |
| Returns | StateVariable::Key |