gemseo.post.topology_view_settings module#

Settings for post-processing.

Settings TopologyView_Settings(*, save=True, show=False, file_path='', directory_path='', file_name='', file_extension='', fig_size=(6.4, 4.8), n_x, n_y, observable='', iterations=())[source]#

Bases: BasePostSettings

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

  • save (bool) --

    By default it is set to True.

  • show (bool) --

    By default it is set to False.

  • file_path (Path | str) --

    By default it is set to "".

  • directory_path (Path | str) --

    By default it is set to "".

  • file_name (str) --

    By default it is set to "".

  • file_extension (str) --

    By default it is set to "".

  • fig_size (tuple[Annotated[float, Gt(gt=0)], Annotated[float, Gt(gt=0)]]) --

    By default it is set to (6.4, 4.8).

  • n_x (Annotated[int, Gt(gt=0)])

  • n_y (Annotated[int, Gt(gt=0)])

  • observable (str) --

    By default it is set to "".

  • iterations (int | Sequence[int]) --

    By default it is set to ().

Return type:

None

iterations: int | Sequence[int] = ()#

The iterations of the optimization history. If empty, the last iteration is taken.

n_x: PositiveInt [Required]#

The number of elements in the horizontal direction.

Constraints:

  • gt = 0

n_y: PositiveInt [Required]#

The number of elements in the vertical direction.

Constraints:

  • gt = 0

observable: str = ''#

The name of the observable to be plotted. It should be of size n_x*n_y.

model_post_init(context, /)#

We need to both initialize private attributes and call the user-defined model_post_init method.

Parameters:

  • self (BaseModel)

  • context (Any)

Return type:

None