rompy.schism.namelists.param.Core#

pydantic model rompy.schism.namelists.param.Core[source]#

Show JSON schema

{
   "title": "Core",
   "type": "object",
   "properties": {
      "ipre": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Pre-processor flag (1: on; 0: off). Useful for checking grid errors etc. Use 1 core only for compute (plus necessary scribe cores) when enabled. Under scribe I/O, the code (scribe part) will hang but outputs will be available. Job should be manually terminated.",
         "title": "Ipre"
      },
      "ibc": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Baroclinic option flag. If set to 0 (baroclinic model), ibtp is not used.",
         "title": "Ibc"
      },
      "ibtp": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Barotropic option flag. Only used when ibc is not 0.",
         "title": "Ibtp"
      },
      "rnday": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 30,
         "description": "Total run time in days.",
         "title": "Rnday"
      },
      "dt": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 100.0,
         "description": "Time step in seconds.",
         "title": "Dt"
      },
      "msc2": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 24,
         "description": "Number of spectral frequencies for WWM grid. Must be the same as msc in .nml for consistency between SCHISM and WWM.",
         "title": "Msc2"
      },
      "mdc2": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 24,
         "description": "Number of directional bins for WWM grid. Must be the same as mdc in .nml for consistency between SCHISM and WWM.",
         "title": "Mdc2"
      },
      "ntracer_gen": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 2,
         "description": "Number of tracers in user-defined module (USE_GEN).",
         "title": "Ntracer Gen"
      },
      "ntracer_age": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 4,
         "description": "Number of tracers for age calculation (USE_AGE). Must be equal to 2*N where N is the number of age tracers.",
         "title": "Ntracer Age"
      },
      "sed_class": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 5,
         "description": "Number of sediment classes for SED3D module (USE_SED).",
         "title": "Sed Class"
      },
      "eco_class": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 27,
         "description": "Number of ecological variables for EcoSim module (USE_ECO). Must be between 25 and 60, inclusive.",
         "title": "Eco Class"
      },
      "nspool": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 36,
         "description": "Output step spool for global output controls.",
         "title": "Nspool"
      },
      "ihfskip": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 864,
         "description": "Stack spool for global output controls. Every ihfskip steps will be put into 1_*, 2_*, etc.",
         "title": "Ihfskip"
      }
   },
   "additionalProperties": false
}

field dt: float | None = 100.0#

Time step in seconds.

Validated by:

__lowercase_property_keys__
validate_dt
validate_ibc_ibtp

field eco_class: int | None = 27#

Number of ecological variables for EcoSim module (USE_ECO). Must be between 25 and 60, inclusive.

Validated by:

__lowercase_property_keys__
validate_eco_class
validate_ibc_ibtp

field ibc: int | None = 0#

Baroclinic option flag. If set to 0 (baroclinic model), ibtp is not used.

Validated by:

__lowercase_property_keys__
validate_ibc
validate_ibc_ibtp

field ibtp: int | None = 1#

Barotropic option flag. Only used when ibc is not 0.

Validated by:

__lowercase_property_keys__
validate_ibc_ibtp
validate_ibtp

field ihfskip: int | None = 864#

Stack spool for global output controls. Every ihfskip steps will be put into 1_*, 2_*, etc.

Validated by:

__lowercase_property_keys__
validate_ibc_ibtp
validate_ihfskip

field ipre: int | None = 0#

Pre-processor flag (1: on; 0: off). Useful for checking grid errors etc. Use 1 core only for compute (plus necessary scribe cores) when enabled. Under scribe I/O, the code (scribe part) will hang but outputs will be available. Job should be manually terminated.

Validated by:

__lowercase_property_keys__
validate_ibc_ibtp
validate_ipre

field mdc2: int | None = 24#

Number of directional bins for WWM grid. Must be the same as mdc in .nml for consistency between SCHISM and WWM.

Validated by:

__lowercase_property_keys__
validate_ibc_ibtp
validate_mdc2

field msc2: int | None = 24#

Number of spectral frequencies for WWM grid. Must be the same as msc in .nml for consistency between SCHISM and WWM.

Validated by:

__lowercase_property_keys__
validate_ibc_ibtp
validate_msc2

field nspool: int | None = 36#

Output step spool for global output controls.

Validated by:

__lowercase_property_keys__
validate_ibc_ibtp
validate_nspool

field ntracer_age: int | None = 4#

Number of tracers for age calculation (USE_AGE). Must be equal to 2*N where N is the number of age tracers.

Validated by:

__lowercase_property_keys__
validate_ibc_ibtp
validate_ntracer_age

field ntracer_gen: int | None = 2#

Number of tracers in user-defined module (USE_GEN).

Validated by:

__lowercase_property_keys__
validate_ibc_ibtp
validate_ntracer_gen

field rnday: float | None = 30#

Total run time in days.

Validated by:

__lowercase_property_keys__
validate_ibc_ibtp
validate_rnday

field sed_class: int | None = 5#

Number of sediment classes for SED3D module (USE_SED).

Validated by:

__lowercase_property_keys__
validate_ibc_ibtp
validate_sed_class

validator validate_dt » dt [source]#

validator validate_eco_class » eco_class[source]#

validator validate_ibc » ibc[source]#

validator validate_ibc_ibtp » all fields[source]#

validator validate_ibtp » ibtp[source]#

validator validate_ihfskip » ihfskip[source]#

validator validate_ipre » ipre[source]#

validator validate_mdc2 » mdc2[source]#

validator validate_msc2 » msc2[source]#

validator validate_nspool » nspool[source]#

validator validate_ntracer_age » ntracer_age[source]#

validator validate_ntracer_gen » ntracer_gen[source]#

validator validate_rnday » rnday[source]#

validator validate_sed_class » sed_class[source]#

Table of Contents

rompy.schism.namelists.param.Core#

This Page