gemseo / problems / scalable / parametric / core

Hide inherited members

variable_names module

The functions to define the names of the variables used in the scalable problem.

gemseo.problems.scalable.parametric.core.variable_names.get_constraint_name(index)

Return the name of the constraint specific to a scalable discipline.

Parameters:

index (int) – The index of the scalable discipline.

Returns:

The name of the constraint specific to the scalable discipline.

Return type:

str

gemseo.problems.scalable.parametric.core.variable_names.get_coupling_name(index)

Return the name of the coupling variable outputted by a scalable discipline.

Parameters:

index (int) – The index of the scalable discipline.

Returns:

The name of the coupling variable outputted by the scalable discipline.

Return type:

str

gemseo.problems.scalable.parametric.core.variable_names.get_u_local_name(index)

Return the name of an uncertain variable specific to a scalable discipline.

Parameters:

index (int) – The index of the scalable discipline.

Returns:

The name of the uncertain variable specific to the scalable discipline.

Return type:

str

gemseo.problems.scalable.parametric.core.variable_names.get_x_local_name(index)

Return the name of the design variable specific to a scalable discipline.

Parameters:

index (int) – The index of the scalable discipline.

Returns:

The name of the design variable specific to the scalable discipline.

Return type:

str

gemseo.problems.scalable.parametric.core.variable_names.CONSTRAINT_VARIABLE_BASE_NAME: Final[str] = 'c'

The base name of a constraint.

To be suffixed by the index of the corresponding scalable discipline, e.g. "c_3".

gemseo.problems.scalable.parametric.core.variable_names.COUPLING_VARIABLE_BASE_NAME: Final[str] = 'y'

The base name of a coupling variable.

To be suffixed by the index of the corresponding scalable discipline, e.g. "y_3".

gemseo.problems.scalable.parametric.core.variable_names.LOCAL_DESIGN_VARIABLE_BASE_NAME: Final[str] = 'x'

The base name of a design variable.

To be suffixed by the index of the corresponding scalable discipline, e.g. "x_3".

gemseo.problems.scalable.parametric.core.variable_names.OBJECTIVE_NAME: Final[str] = 'f'

The name of the objective.

gemseo.problems.scalable.parametric.core.variable_names.SHARED_DESIGN_VARIABLE_NAME: Final[str] = 'x_0'

The name of the shared design variables.

gemseo.problems.scalable.parametric.core.variable_names.UNCERTAIN_VARIABLE_BASE_NAME: Final[str] = 'u'

The base name of an uncertain variable.

To be suffixed by the index of the corresponding scalable discipline, e.g. "u_3".