gemseo / formulations

formulations_factory module

A factory to instantiate a formulation or check its availability.

Classes:

MDOFormulationsFactory()

MDO Formulations factory to create the formulation from a name or a class.

class gemseo.formulations.formulations_factory.MDOFormulationsFactory

Bases: object

MDO Formulations factory to create the formulation from a name or a class.

Scan the directories to search for subclasses of MDOFormulation.

Searches in “GEMSEO_PATH” and gemseo.formulations

Methods:

create(formulation_name, disciplines, …)	Create a formulation.
is_available(formulation_name)	Check the availability of a formulation.

Attributes:

formulations

The available formulations.

Return type

None

create(formulation_name, disciplines, objective_name, design_space, **options)

Create a formulation.

Parameters

• formulation_name (str) – The name of a class implementing a formulation.

• disciplines (Sequence[gemseo.core.discipline.MDODiscipline]) – The disciplines.

• objective_name (str) – The name of the objective function.

• design_space (gemseo.algos.design_space.DesignSpace) – The design space.

• **options – The options for the creation of the formulation.

Return type

gemseo.core.formulation.MDOFormulation

property formulations

The available formulations.

is_available(formulation_name)

Check the availability of a formulation.

Parameters

• if the formulation is available. (True) –

• formulation_name (str) –

Return type

bool