Skip to content

Output

Sub-commands to support the output components

SPEC1D

Bases: BaseSubComponent

Frequency 1D spectra.

.. code-block:: text

SPEC1D

Examples

.. ipython:: python :okwarning:

from rompy_swan.subcomponents.output import SPEC1D
spec = SPEC1D()
print(spec.render())
Source code in rompy_swan/subcomponents/output.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
class SPEC1D(BaseSubComponent):
    """Frequency 1D spectra.

    .. code-block:: text

        SPEC1D

    Examples
    --------

    .. ipython:: python
        :okwarning:

        from rompy_swan.subcomponents.output import SPEC1D
        spec = SPEC1D()
        print(spec.render())

    """

    model_type: Literal["spec1d", "SPEC1D"] = Field(
        default="spec1d", description="Model type discriminator"
    )

    def cmd(self) -> str:
        """Command file string for this subcomponent."""
        return "SPEC2D"

Attributes

model_type class-attribute instance-attribute 

model_type: Literal['spec1d', 'SPEC1D'] = Field(default='spec1d', description='Model type discriminator')

Functions

cmd 

cmd() -> str

Command file string for this subcomponent.

Source code in rompy_swan/subcomponents/output.py 
38
39
40
def cmd(self) -> str:
    """Command file string for this subcomponent."""
    return "SPEC2D"

SPEC2D

Bases: BaseSubComponent

Frequency-direction 2D spectra.

.. code-block:: text

SPEC2D

Examples

.. ipython:: python :okwarning:

from rompy_swan.subcomponents.output import SPEC2D
spec = SPEC2D()
print(spec.render())
Source code in rompy_swan/subcomponents/output.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
class SPEC2D(BaseSubComponent):
    """Frequency-direction 2D spectra.

    .. code-block:: text

        SPEC2D

    Examples
    --------

    .. ipython:: python
        :okwarning:

        from rompy_swan.subcomponents.output import SPEC2D
        spec = SPEC2D()
        print(spec.render())

    """

    model_type: Literal["spec2d", "SPEC2D"] = Field(
        default="spec2d", description="Model type discriminator"
    )

    def cmd(self) -> str:
        """Command file string for this subcomponent."""
        return "SPEC2D"

Attributes

model_type class-attribute instance-attribute 

model_type: Literal['spec2d', 'SPEC2D'] = Field(default='spec2d', description='Model type discriminator')

Functions

cmd 

cmd() -> str

Command file string for this subcomponent.

Source code in rompy_swan/subcomponents/output.py 
66
67
68
def cmd(self) -> str:
    """Command file string for this subcomponent."""
    return "SPEC2D"

ABS

Bases: BaseSubComponent

Absolute frequency spectra.

.. code-block:: text

ABS

Spectra are computed as a function of absolute frequency, i.e., the frequency as measured in a fixed point.

Examples

.. ipython:: python :okwarning:

from rompy_swan.subcomponents.output import ABS
freq = ABS()
print(freq.render())
Source code in rompy_swan/subcomponents/output.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
class ABS(BaseSubComponent):
    """Absolute frequency spectra.

    .. code-block:: text

        ABS

    Spectra are computed as a function of absolute frequency, i.e., the frequency as
    measured in a fixed point.

    Examples
    --------

    .. ipython:: python
        :okwarning:

        from rompy_swan.subcomponents.output import ABS
        freq = ABS()
        print(freq.render())

    """

    model_type: Literal["abs", "ABS"] = Field(
        default="abs", description="Model type discriminator"
    )

    def cmd(self) -> str:
        """Command file string for this subcomponent."""
        return "ABS"

Attributes

model_type class-attribute instance-attribute 

model_type: Literal['abs', 'ABS'] = Field(default='abs', description='Model type discriminator')

Functions

cmd 

cmd() -> str

Command file string for this subcomponent.

Source code in rompy_swan/subcomponents/output.py 
97
98
99
def cmd(self) -> str:
    """Command file string for this subcomponent."""
    return "ABS"

REL

Bases: BaseSubComponent

Relative frequency spectra.

.. code-block:: text

REL

Spectra are computed as a function of relative frequency, i.e., the frequency as measured when moving with current.

Examples

.. ipython:: python :okwarning:

from rompy_swan.subcomponents.output import REL
freq = REL()
print(freq.render())
Source code in rompy_swan/subcomponents/output.py 
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
class REL(BaseSubComponent):
    """Relative frequency spectra.

    .. code-block:: text

        REL

    Spectra are computed as a function of relative frequency, i.e., the frequency as
    measured when moving with current.

    Examples
    --------

    .. ipython:: python
        :okwarning:

        from rompy_swan.subcomponents.output import REL
        freq = REL()
        print(freq.render())

    """

    model_type: Literal["rel", "REL"] = Field(
        default="rel", description="Model type discriminator"
    )

    def cmd(self) -> str:
        """Command file string for this subcomponent."""
        return "REL"

Attributes

model_type class-attribute instance-attribute 

model_type: Literal['rel', 'REL'] = Field(default='rel', description='Model type discriminator')

Functions

cmd 

cmd() -> str

Command file string for this subcomponent.

Source code in rompy_swan/subcomponents/output.py 
128
129
130
def cmd(self) -> str:
    """Command file string for this subcomponent."""
    return "REL"