ModelSettings

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

Bases: ModelSettingsBase

Model settings for the 3D non-hydrostatic 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

N2	The stratification N².
Ro	The Rossby number.
beta	The beta term of the Coriolis parameter (f=f0 + beta*y).
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 of the Coriolis parameter (f=f0 + beta*y).
f_coriolis	The Coriolis parameter (f=f0 + beta*y).
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.nonhydro.ModelSettings

Barotropic Jet

Barotropic Jet

Reflecting Wave Package

Reflecting Wave Package

Internal Gravity Wave Maker

Internal Gravity Wave Maker

Convection and Closures

Convection and Closures

Multiple Wave Makers

Multiple Wave Makers

Rayleigh-Taylor Instability

Rayleigh-Taylor Instability

Rayleigh-Bénard Convection

Rayleigh-Bénard Convection

Single Internal Wave

Single Internal Wave

Dancing Eddies

Dancing Eddies

Symmetric Instability

Symmetric Instability

Tracers and Eddies

Tracers and Eddies

model_name = '3D - Nonhydrostatic model'

setup_settings_parameters()

Set the model settings parameters up.

state_constructor()

Construct the state vector from this model settings.

diagnostic_state_constructor()

Construct the diagnostic 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 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 Coriolis parameter (f=f0 + beta*y).

property N2: float

The stratification N².

property Ro: float

The Rossby number.

property dsqr: float

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