ishigami_discipline module¶
The Ishigami function as a discipline.
- class gemseo.uncertainty.use_cases.ishigami.ishigami_discipline.IshigamiDiscipline[source]
Bases:
MDODisciplineThe Ishigami function as a discipline.
Initialize self. See help(type(self)) for accurate signature.
- Parameters:
name – The name of the discipline. If None, use the class name.
input_grammar_file – The input grammar file path. If
Noneandauto_detect_grammar_files=True, look for"ClassName_input.json"in theGRAMMAR_DIRECTORYif any or in the directory of the discipline class module. IfNoneandauto_detect_grammar_files=False, do not initialize the input grammar from a schema file.output_grammar_file – The output grammar file path. If
Noneandauto_detect_grammar_files=True, look for"ClassName_output.json"in theGRAMMAR_DIRECTORYif any or in the directory of the discipline class module. IfNoneandauto_detect_grammar_files=False, do not initialize the output grammar from a schema file.auto_detect_grammar_files – Whether to look for
"ClassName_{input,output}.json"in theGRAMMAR_DIRECTORYif any or in the directory of the discipline class module when{input,output}_grammar_fileisNone.grammar_type – The type of the input and output grammars.
cache_type – The type of cache.
cache_file_path – The HDF file path when
grammar_typeisMDODiscipline.CacheType.HDF5.
- cache: AbstractCache | None
The cache containing one or several executions of the discipline according to the cache policy.
- data_processor: DataProcessor
A tool to pre- and post-process discipline data.
- exec_for_lin: bool
Whether the last execution was due to a linearization.
- input_grammar: BaseGrammar
The input grammar.
- jac: dict[str, dict[str, ndarray]]
The Jacobians of the outputs wrt inputs.
The structure is
{output: {input: matrix}}.
- name: str
The name of the discipline.
- output_grammar: BaseGrammar
The output grammar.
- re_exec_policy: ReExecutionPolicy
The policy to re-execute the same discipline.
- residual_variables: Mapping[str, str]
The output variables mapping to their inputs, to be considered as residuals; they shall be equal to zero.
- run_solves_residuals: bool
Whether the run method shall solve the residuals.
