ModelSettings

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

Bases: ModelSettingsBase

Model settings for the 3D non-hydrostatic model.

Parameters

gridGrid

The grid object.

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

Methods

__init__(grid, **kwargs)
diagnostic_state_constructor()	Construct the diagnostic state vector from this model settings.
set_attributes(**kwargs)	Set model settings attributes from keyword arguments.
setup([setup_mode])	Set the model settings up.
setup_grid([setup_mode])	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².
N2_field	The stratification N² field.
Ro	The Rossby number.
beta	The beta term of the Coriolis parameter (f=f0 + beta*y).
custom_diagnostic_fields	List of custom diagnostic fields.
custom_state_fields	List of custom state fields.
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.
is_setup	Return whether the model settings are set up.
model_name
nan_checker	The NaN checker object (default: NaNChecker).
parameters	Return a dictionary with all parameters of the model settings.
progress_bar	The progress bar object (default: ProgressBar).
raise_error_when_something_goes_wrong	Raise an error when something goes wrong.
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

Convection and Closures

Convection and Closures

Dancing Eddies

Dancing Eddies

Internal Gravity Wave Maker

Internal Gravity Wave Maker

Multiple Wave Makers

Multiple Wave Makers

Rayleigh-Bénard Convection

Rayleigh-Bénard Convection

Rayleigh-Taylor Instability

Rayleigh-Taylor Instability

Single Internal Wave

Single Internal Wave

Symmetric Instability

Symmetric Instability

Tracers and Eddies

Tracers and Eddies

Reflecting Wave Package

Reflecting Wave Package

model_name = '3D - Nonhydrostatic model'

setup_settings_parameters() → None

Set the model settings parameters up.

state_constructor() → State

Construct the state vector from this model settings.

diagnostic_state_constructor() → DiagnosticState

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: ScalarField

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

property N2: float

The stratification N².

property N2_field: ScalarField

The stratification N² field.

property Ro: float

The Rossby number.

property dsqr: float

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