gemseo.disciplines.wrappers.filtering_discipline module#

Filtering wrapper.

class FilteringDiscipline(discipline, input_names=None, output_names=None, keep_in=True, keep_out=True)[source]#

Bases: Discipline

A class to wrap another Discipline for a subset of inputs and outputs.

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

Parameters:
  • discipline (Discipline) -- The original discipline.

  • input_names (Iterable[str] | None) -- The names of the inputs of interest. If None, use all the inputs.

  • output_names (Iterable[str] | None) -- The names of the outputs of interest. If None, use all the outputs.

  • keep_in (bool) --

    Whether to keep the inputs of interest. Otherwise, remove them.

    By default it is set to True.

  • keep_out (bool) --

    Whether to keep the outputs of interest. Otherwise, remove them.

    By default it is set to True.

cache: BaseCache | None#

The execution and linearization data saved according to the cache type.

execution_statistics: ExecutionStatistics#

The execution statistics of the process.

execution_status: ExecutionStatus#

The execution status of the process.

jac: JacobianData#

The Jacobian matrices of the outputs.

The structure is {output_name: {input_name: jacobian_matrix}}.

name: str#

The name of the process.