phlower.settings.RolloutVariableSetting¶

class phlower.settings.RolloutVariableSetting(*, state_variable, increment_variable)[source]¶

Bases: BaseModel

Methods

Attributes

`model_computed_fields`
`model_config`	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
`model_extra`	Get extra fields set during validation.
`model_fields`
`model_fields_set`	Returns the set of fields that have been explicitly set on this model instance.
`state_variable`	Name of the input variable which is updated at every step.
`increment_variable`	Name of the output variable which is added to the state.

Parameters:

state_variable (str)
increment_variable (str)

increment_variable: str¶: Name of the output variable which is added to the state.

model_config = {'extra': 'forbid', 'frozen': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

state_variable: str¶: Name of the input variable which is updated at every step.