gemseo.problems.mdo.scalable.parametric.core.variable_names module

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

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

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

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

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

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".

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".

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".

OBJECTIVE_NAME: Final[str] = 'f'

The name of the objective.

SHARED_DESIGN_VARIABLE_NAME: Final[str] = 'x_0'

The name of the shared design variables.

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".