gemseo_umdo / use_cases / heat_equation

Show inherited members

discipline module

The heat equation discipline.

This discipline wraps the [HeatEquationModel][gemseo_umdo.use_cases.heat_equation.model.HeatEquationModel]; read its docstring for more details.

class gemseo_umdo.use_cases.heat_equation.discipline.HeatEquation(mesh_size=100, n_modes=21, final_time=0.5, nu_bounds=(0.001, 0.009), rod_length=1.0)[source]

Bases: MDODiscipline

The discipline computing the temperature averaged over the rod at final time.

Initialize self. See help(type(self)) for accurate signature.

Parameters:
  • mesh_size (int) –

    The number of equispaced spatial nodes.

    By default it is set to 100.

  • n_modes (int) –

    The number of modes of the truncated Fourier expansion.

    By default it is set to 21.

  • final_time (float) –

    The time of interest.

    By default it is set to 0.5.

  • nu_bounds (tuple[float, float]) –

    The bounds of the thermal diffusivity.

    By default it is set to (0.001, 0.009).

  • rod_length (float) –

    The length of the rod.

    By default it is set to 1.0.

cache: AbstractCache | None

The cache containing one or several executions of the discipline according to the cache policy.

property configuration: HeatEquationConfiguration

The configuration.

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.