Temperature Salinity

R2026b

Estimate in situ temperature and practical salinity of seawater

Since R2026b

Libraries:
Aerospace Blockset Maritime Applications Library / Environment

Description

Add-On Required: This feature requires the Aerospace Blockset Maritime Applications Library add-on.

The Temperature Salinity block provides in-situ temperature and practical salinity of seawater by interpolating the World Ocean Atlas 2023 (WOA23) climatology decade long data set across depth, latitude, and longitude.

Ports

Input

expand all

depth — Ocean depth below surface
scalar between 0 and 5500 m, inclusive

Ocean depth below surface in the ocean, specified as a scalar value between 0 and 5500 m, inclusive, in the units specified in Units.

Data Types: double

μ — Latitude
scalar between -90 and 90 deg, inclusive

Latitude for temperature and salinity lookup, specified as a scalar value between -90 and 90 deg, inclusive. The block wraps out-of-range values from -90 to 90, inclusive, before evaluation. μ specifies the latitude when retrieving gridded ocean temperature and salinity data from the World Ocean Atlas 2023 climatology data set. μ and l identify the ocean location at which temperature and salinity are evaluated.

Data Types: double

l — Longitude
scalar between -180 and 180 deg, inclusive

Longitude for temperature and salinity lookup, specified as a scalar in degrees between [-180, 180] deg, inclusive. μ and l identify the ocean location at which temperature and salinity are evaluated.

l specifies the longitude when retrieving gridded ocean temperature and salinity data from the World Ocean Atlas 2023 climatology data set. The block wraps out-of-range values from -180 to 180, inclusive, before evaluation.

Data Types: double

Output

expand all

t_in-situ — In-situ temperature
scalar

In-situ temperature, returned as a scalar value in the units specified in Units. When the query location has no valid ocean data, such as land cells, the block returns NaN or the specified fill value, depending on the block parameter settings.

Data Types: double

S_P — Practical salinity
scalar

Practical salinity (PSS-78), returned as a scalar value. When the query location has no valid ocean data, such as land cells, the block returns NaN or the specified fill value, depending on the block parameter settings. This value is unitless.

Data Types: double

Parameters

expand all

To edit block parameters interactively, use the Property Inspector. From the Simulink^® Toolstrip, on the Simulation tab, in the Prepare gallery, select Property Inspector.

Units — Parameter and port units
`Metric (MKS)` (default) | `English`

Parameter and port units, specified as one of these values:

Units	Depth	Temperature
`Metric (MKS)`	meters	degrees Celsius (°C)
`English`	feet	degrees Fahrenheit (°F)

Programmatic Use

To set the block parameter value programmatically, use the set_param function.

To get the block parameter value programmatically, use the get_param function.

Parameter:	`units`
Values:	`Metric (MKS)` (default) \| `English`

Example: set_param(gcb,"units","Metric (MKS)")

Action for out-of-range input — Out-of-range block behavior
`Error` (default) | `Warning` | `None`

Out-of-range block behavior, specified as one of these values:

Action	Description
`None`	`NaN`s are returned.
`Warning`	Warning in the Diagnostic Viewer. Model simulation continues.
`Error` (default)	Error in the Diagnostic Viewer. Model simulation stops.

Programmatic Use

To set the block parameter value programmatically, use the set_param function.

To get the block parameter value programmatically, use the get_param function.

Parameter:	`action`
Values:	`Error` (default) \| `Warning` \| `None`

Example: set_param(gcb,"action","Warning")

Use constant fill values for out-of-range results — Option to fill with constant values
`off` (default) | `on`

To enable the use of constant fill values for out-of-range results, select this parameter. Otherwise, clear this parameter.

Dependencies

To enable this parameter, set the Action for out-of-range input parameter to Warning or None.

Programmatic Use

To set the block parameter value programmatically, use the set_param function.

To get the block parameter value programmatically, use the get_param function.

Parameter:	`fillConst`
Values:	`off` (default) \| `on`

Example: set_param(gcb,"fillConst","off")

Fill value for in situ temperature — Fill with constant value for temperature
`10` (default) | real finite scalar

Fill with constant value for temperature, specified as a real finite scalar in the units specified in Units.

Dependencies

To enable this parameter:

Select the Use constant fill values for out-of-range results parameter.
To enable this parameter, set the Action for out-of-range input parameter to Warning or None.

Programmatic Use

To set the block parameter value programmatically, use the set_param function.

To get the block parameter value programmatically, use the get_param function.

Parameter:	`fillValueT`
Values:	`10` (default) \| real finite scalar
Data Types:	`double`

Example: set_param(gcb,"fillValueT","10")

Fill value for practical salinity — Fill with constant value for salinity
`35` (default) | real finite scalar

Fill with constant value for practical salinity (PSS-78), specified as a real finite scalar. This value is unitless.

Dependencies

To enable this parameter:

Select the Use constant fill values for out-of-range results parameter.
To enable this parameter, set the Action for out-of-range input parameter to Warning or None.

Programmatic Use

To set the block parameter value programmatically, use the set_param function.

To get the block parameter value programmatically, use the get_param function.

Parameter:	`fillValueSP`
Values:	`35` (default) \| real finite scalar
Data Types:	`double`

Example: set_param(gcb,"fillValueSP","35")

Version History

Introduced in R2026b

Temperature Salinity

Description

Ports

Input

depth — Ocean depth below surface
scalar between 0 and 5500 m, inclusive

μ — Latitude
scalar between -90 and 90 deg, inclusive

l — Longitude
scalar between -180 and 180 deg, inclusive

Output

t_in-situ — In-situ temperature
scalar

S_P — Practical salinity
scalar

Parameters

Units — Parameter and port units
`Metric (MKS)` (default) | `English`

Programmatic Use

Action for out-of-range input — Out-of-range block behavior
`Error` (default) | `Warning` | `None`

Programmatic Use

Use constant fill values for out-of-range results — Option to fill with constant values
`off` (default) | `on`

Dependencies

Programmatic Use

Fill value for in situ temperature — Fill with constant value for temperature
`10` (default) | real finite scalar

Dependencies

Programmatic Use

Fill value for practical salinity — Fill with constant value for salinity
`35` (default) | real finite scalar

Dependencies

Programmatic Use

Version History

See Also

Topics

External Websites

Temperature Salinity

Description

Ports

Input

depth — Ocean depth below surface scalar between 0 and 5500 m, inclusive

μ — Latitude scalar between -90 and 90 deg, inclusive

l — Longitude scalar between -180 and 180 deg, inclusive

Output

tin-situ — In-situ temperature scalar

SP — Practical salinity scalar

Parameters

Units — Parameter and port units Metric (MKS) (default) | English

Programmatic Use

Action for out-of-range input — Out-of-range block behavior Error (default) | Warning | None

Programmatic Use

Use constant fill values for out-of-range results — Option to fill with constant values off (default) | on

Dependencies

Programmatic Use

Fill value for in situ temperature — Fill with constant value for temperature 10 (default) | real finite scalar

Dependencies

Programmatic Use

Fill value for practical salinity — Fill with constant value for salinity 35 (default) | real finite scalar

Dependencies

Programmatic Use

Version History

See Also

Topics

External Websites

depth — Ocean depth below surface
scalar between 0 and 5500 m, inclusive

μ — Latitude
scalar between -90 and 90 deg, inclusive

l — Longitude
scalar between -180 and 180 deg, inclusive

t_in-situ — In-situ temperature
scalar

S_P — Practical salinity
scalar

Units — Parameter and port units
`Metric (MKS)` (default) | `English`

Action for out-of-range input — Out-of-range block behavior
`Error` (default) | `Warning` | `None`

Use constant fill values for out-of-range results — Option to fill with constant values
`off` (default) | `on`

Fill value for in situ temperature — Fill with constant value for temperature
`10` (default) | real finite scalar

Fill value for practical salinity — Fill with constant value for salinity
`35` (default) | real finite scalar