disciplines_factory module¶
Factory to create disciplines.
- class gemseo.problems.disciplines_factory.DisciplinesFactory[source]¶
Bases:
BaseFactory
The DisciplinesFactory is used to create
MDODiscipline
objects.Three types of directories are scanned to import the
MDODiscipline
classes:the environment variable “GEMSEO_PATH” may contain the list of directories to scan,
the present directory (gemseo.problems) contains some benchmark test cases,
The constructor initializes the factory by scanning the directories to search for subclasses of
MDODiscipline
objects.Searches in “GEMSEO_PATH” and gemseo.problems.
- Return type:
Any
- create(discipline_name, **options)[source]¶
Create an
MDODiscipline
from its name.
- get_class(name)¶
Return a class from its name.
- Parameters:
name (str) – The name of the class.
- Returns:
The class.
- Raises:
ImportError – If the class is not available.
- Return type:
- get_default_option_values(name)¶
Return the constructor kwargs default values of a class.
- get_default_sub_option_values(name, **options)¶
Return the default values of the sub options of a class.
- Parameters:
- Returns:
The JSON grammar.
- Return type:
- get_library_name(name)¶
Return the name of the library related to the name of a class.
- get_options_doc(name)¶
Return the constructor documentation of a class.
- get_options_grammar(name, write_schema=False, schema_path=None)[source]¶
Get the options default values for the given class name.
- Parameters:
- Returns:
The JSON grammar of the options.
- Return type:
- get_sub_options_grammar(name, **options)¶
Return the JSONGrammar of the sub options of a class.
- Parameters:
- Returns:
The JSON grammar.
- Return type:
- is_available(name)¶
Return whether a class can be instantiated.
- update()¶
Search for the classes that can be instantiated.
- The search is done in the following order:
The fully qualified module names
The plugin packages
The packages from the environment variables
- Return type:
None