rompy.swan.subcomponents.physics.RDIFF#

pydantic model rompy.swan.subcomponents.physics.RDIFF[source]#

Diffuse reflection.

RDIFF [pown]

Specular reflection where incident waves are scattered over reflected direction.

Examples

In [40]: from rompy.swan.subcomponents.physics import RDIFF

In [41]: refl = RDIFF()

In [42]: print(refl.render())
RDIFF

In [43]: refl = RDIFF(pown=1.0)

In [44]: print(refl.render())
RDIFF pown=1.0

Show JSON schema
{
   "title": "RDIFF",
   "description": "Diffuse reflection.\n\n.. code-block:: text\n\n    RDIFF [pown]\n\nSpecular reflection where incident waves are scattered over reflected direction.\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.subcomponents.physics import RDIFF\n    refl = RDIFF()\n    print(refl.render())\n    refl = RDIFF(pown=1.0)\n    print(refl.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "rdiff",
         "description": "Model type discriminator",
         "enum": [
            "rdiff",
            "RDIFF"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "pown": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Each incoming direction \u03b8 is scattered over reflected direction \u03b8_refl according to cos^pown(\u03b8-\u03b8_refl). The parameter `pown` indicates the widthof the redistribution function (SWAN default: 1.0)",
         "title": "Pown"
      }
   },
   "additionalProperties": false
}

Fields:
field model_type: Literal['rdiff', 'RDIFF'] = 'rdiff'#

Model type discriminator

field pown: float | None = None#

Each incoming direction θ is scattered over reflected direction θ_refl according to cos^pown(θ-θ_refl). The parameter pown indicates the widthof the redistribution function (SWAN default: 1.0)

cmd() → str[source]#

Command file string for this subcomponent.