rompy.schism.data.SCHISMDataOcean

pydantic model rompy.schism.data.SCHISMDataOcean

This class is used define all ocean boundary forcing

Fields:

• SAL_3D (rompy.core.data.DataBlob | rompy.schism.data.SCHISMDataBoundary | None)

• TEM_3D (rompy.core.data.DataBlob | rompy.schism.data.SCHISMDataBoundary | None)

• data_type (Literal['ocean'])

• elev2D (rompy.core.data.DataBlob | rompy.schism.data.SCHISMDataBoundary | None)

• uv3D (rompy.core.data.DataBlob | rompy.schism.data.SCHISMDataBoundary | None)

Validators:

• not_yet_implemented » all fields

• set_id » all fields

field SAL_3D: DataBlob | SCHISMDataBoundary | None = None

SAL_3D

Validated by:

• not_yet_implemented

• set_id

field TEM_3D: DataBlob | SCHISMDataBoundary | None = None

TEM_3D

Validated by:

• not_yet_implemented

• set_id

field data_type: Literal['ocean'] = 'ocean'

Model type discriminator

Validated by:

• not_yet_implemented

• set_id

field elev2D: DataBlob | SCHISMDataBoundary | None = None

elev2D

Validated by:

• not_yet_implemented

• set_id

field uv3D: DataBlob | SCHISMDataBoundary | None = None

uv3D

Validated by:

• not_yet_implemented

• set_id

get(destdir: str | Path, grid: SCHISMGrid, time: TimeRange | None = None) → str

Write all inputs to netcdf files. :param destdir: Destination directory for the netcdf file. :type destdir: str | Path :param grid: Grid instance to use for selecting the boundary points. :type grid: SCHISMGrid, :param time: The times to filter the data to, only used if self.crop_data is True. :type time: TimeRange, optional

Returns:

outfile – Path to the netcdf file.

Return type:

Path

validator not_yet_implemented  »  all fields

validator set_id  »  all fields