rompy.swan.components.numerics.NUMERIC#

pydantic model rompy.swan.components.numerics.NUMERIC[source]#

Numerical properties.

NUMeric ( STOPC [dabs] [drel] [curvat] [npnts] ->STAT|NONSTAT [limiter] ) &
    ( DIRimpl [cdd] ) ( SIGIMpl [css] [eps2] [outp] [niter] ) &
    ( CTheta [cfl] ) ( CSigma [cfl] ) ( SETUP [eps2] [outp] [niter] )

Examples

In [4]: from rompy.swan.components.numerics import NUMERIC

In [5]: numeric = NUMERIC()

In [6]: print(numeric.render())
NUMERIC

In [7]: numeric = NUMERIC(
   ...:     stop=dict(
   ...:         model_type="stopc",
   ...:         dabs=0.05,
   ...:         drel=0.01,
   ...:         curvat=0.05,
   ...:         npnts=99.5,
   ...:     ),
   ...:     dirimpl=dict(cdd=0.5),
   ...:     sigimpl=dict(css=0.5, eps2=1e-4, outp=0, niter=20),
   ...:     ctheta=dict(cfl=0.9),
   ...:     csigma=dict(cfl=0.9),
   ...:     setup=dict(eps2=1e-4, outp=0, niter=20),
   ...: )
   ...: 

In [8]: print(numeric.render())
NUMERIC STOPC dabs=0.05 drel=0.01 curvat=0.05 npnts=99.5 DIRIMPL cdd=0.5 SIGIMPL css=0.5 eps2=0.0001 outp=0 niter=20 CTHETA cfl=0.9
Fields:
field csigma: CSIGMA | None = None#

Prevents excessive frequency shifting

field ctheta: CTHETA | None = None#

Prevents excessive directional turning

field dirimpl: DIRIMPL | None = None#

Numerical scheme for refraction

field model_type: Literal['numeric', 'NUMERIC'] = 'numeric'#

Model type discriminator

field setup: SETUP | None = None#

Stop criteria in the computation of wave setup

field sigimpl: SIGIMPL | None = None#

Frequency shifting accuracy

field stop: STOPC | ACCUR | None = None#

Iteration termination criteria

cmd() → str[source]#

Command file string for this component.

On this page
Show Source