Appearance
adam_turbulence_object
ADAM, the
[turbulence]section: algebraic subgrid-scale model of a realm (issue #119, T1).
sgs_model = none | vreman | wale | sigma (default none; any other value is fatal), sgs_constant (default 0.07 Vreman, 0.5 WALE, 1.35 Sigma; > 0), prandtl_t (default 0.9; > 0). The app owns the object (a realm component), the field and the selection of the kernel of the model: adam_turbulence_kernels (CPU), adam_fnl_turbulence_kernels (FNL).
Source: src/lib/common/adam_turbulence_object.F90
Dependencies
Contents
Variables
| Name | Type | Attributes | Description |
|---|---|---|---|
SGS_NONE | integer(kind=I4P) | parameter | No model. |
SGS_VREMAN_MODEL | integer(kind=I4P) | parameter | Vreman (2004). |
SGS_WALE_MODEL | integer(kind=I4P) | parameter | WALE (Nicoud & Ducros 1999). |
SGS_SIGMA_MODEL | integer(kind=I4P) | parameter | Sigma (Nicoud et al. 2011). |
INI_SECTION_NAME | character(len=10) | parameter | Input section. |
Derived Types
turbulence_object
Subgrid-scale model parameters.
Components
| Name | Type | Attributes | Description |
|---|---|---|---|
model | integer(kind=I4P) | Model id. | |
constant | real(kind=R8P) | Model constant. | |
prandtl_t | real(kind=R8P) | Turbulent Prandtl number. | |
is_active | logical | A model is on. |
Type-Bound Procedures
| Name | Attributes | Description |
|---|---|---|
description | pass(self) | Return pretty-printed object description. |
load_from_file | pass(self) | Load the section. |
Subroutines
load_from_file
Load the section: without it, or with sgs_model = none, no model.
fortran
subroutine load_from_file(self, file_parameters)Arguments
| Name | Type | Intent | Attributes | Description |
|---|---|---|---|---|
self | class(turbulence_object) | inout | Turbulence. | |
file_parameters | type(file_ini) | in | Simulation parameters ini file handler. |
Call graph
Functions
description
Return a pretty-formatted object description.
Returns: character(len=:)
fortran
function description(self) result(desc)Arguments
| Name | Type | Intent | Attributes | Description |
|---|---|---|---|---|
self | class(turbulence_object) | in | Turbulence. |
Call graph