ModelSettings

class fridom.shallowwater.ModelSettings(grid: GridBase, **kwargs)

Bases: ModelSettingsBase

Model settings for the 2D shallow water model.

Parameters

gridGrid

The grid object.

__init__(grid: GridBase, **kwargs) → None

Methods

__init__(grid, **kwargs)
add_field_to_state(kwargs)	Add a field variable to the state vector.
diagnostic_state_constructor()	Construct the diagnostic state vector from this model settings.
set_attributes(**kwargs)	Set model settings attributes from keyword arguments.
setup()	Set the model settings up.
setup_grid()	Set the grid object up.
setup_settings_parameters()	Set the model settings parameters up.
state_constructor()	Construct the state vector from this model settings.

Attributes

Ro	The Rossby number.
beta	The beta term of the Coriolis parameter (f=f0 + beta*y).
csqr	The phase speed of the gravity waves.
csqr_field	The variable c²(x,y) field.
custom_fields	List of custom fields to be added to the state vector.
diagnostics	The module container for all diagnostics.
dsqr	The aspect ratio.
f0	The constant term f0 of the Coriolis parameter (f=f0 + beta*y).
f_coriolis	The variable coriolis parameter field
grid	The spatial grid.
halo	Return the halo size of the model.
model_name
nan_check_interval	The interval at which the model checks for NaN values.
parameters	Return a dictionary with all parameters of the model settings.
progress_bar	The progress bar object (default: ProgressBar).
restart_module	The restart module.
tendencies	The module container for all tendencies.
time_stepper	The time stepper object (default: AdamBashforth).
timer	The timing module.

Examples using fridom.shallowwater.ModelSettings

Barotropic Instability

Barotropic Instability

model_name = 'ShallowWater'

setup_settings_parameters()

Set the model settings parameters up.

state_constructor()

Construct the state vector from this model settings.

property parameters: dict

Return a dictionary with all parameters of the model settings.

Description

This method should be overridden by the child class to return a dictionary with all parameters of the model settings. This dictionary is used to print the model settings in the __repr__ method.

property f0: float

The constant term f0 of the Coriolis parameter (f=f0 + beta*y).

property beta: float

The beta term of the Coriolis parameter (f=f0 + beta*y).

property f_coriolis: FieldVariable

The variable coriolis parameter field

property csqr: float

The phase speed of the gravity waves.

property csqr_field: FieldVariable

The variable c²(x,y) field.

property Ro: float

The Rossby number.

property dsqr: float

The aspect ratio. \(\delta^2\).