ard.geographic.geomorphology

ard.geographic.geomorphology#

Classes

BathymetryGridData()

A class to represent gridded bathymetry data for a given wind farm site domain.

GeomorphologyGridData()

A class to represent gridded geomorphology data for a given wind farm site domain.

TopographyGridData()

A class to represent gridded terrain data for a given wind farm site domain.
class ard.geographic.geomorphology.GeomorphologyGridData[source]#

A class to represent gridded geomorphology data for a given wind farm site domain.

Represents either bathymetry data for offshore sites or topography data for onshore sites.

x_data = array([[0.]])#
y_data = array([[0.]])#
z_data = array([[0.]])#
x_material_data = array([[0.]])#
y_material_data = array([[0.]])#
material_data = array([['soil']], dtype='<U4')#
sea_level = 0.0#
check_valid_geomorphology()[source]#
check_valid_material()[source]#
get_shape()[source]#

Get the shape of the geomorphology data.

Returns:

The shape of the geomorphology data.

Return type:

tuple

get_material_shape()[source]#

Get the shape of the material data.

Returns:

The shape of the material data.

Return type:

tuple

set_data_values(x_data_in, y_data_in, z_data_in)[source]#

Set the values of the geomorphology data.

Parameters:

  • x_data_in (np.ndarray) -- A 2D numpy array indicating the x-dimension locations of the points.

  • y_data_in (np.ndarray) -- A 2D numpy array indicating the y-dimension locations of the points.

  • z_data_in (np.ndarray) -- A 2D numpy array indicating the depth at each point.

  • material_data_in (np.ndarray, optional) -- A 2D numpy array indicating the bed material at each point.

set_material_values(x_material_data_in, y_material_data_in, material_data_in)[source]#

Set the values of the material data.

Parameters:

  • x_material_data_in (np.ndarray) -- A 2D numpy array indicating the x-dimension locations of the points.

  • y_material_data_in (np.ndarray) -- A 2D numpy array indicating the y-dimension locations of the points.

  • material_data_in (np.ndarray) -- A 2D numpy array indicating the bed material at each point.

get_z_data()[source]#

Get the depth at a given location.

get_material_data()[source]#

Get the material data at a given location.

evaluate(x_query, y_query, return_derivs=False, interp_method='spline')[source]#

Evaluate the depth at a given location.

Parameters:

  • x_query (np.array) -- The x locations to sample in km

  • y_query (np.array) -- The y locations to sample in km

Returns:

  • np.array -- the depth at the given locations if return_derivs is False

  • tuple -- the derivatives if return_derivs is True

class ard.geographic.geomorphology.BathymetryGridData[source]#

A class to represent gridded bathymetry data for a given wind farm site domain.

Represents the bathymetry data for offshore sites. Can be used for floating mooring system anchors or for fixed-bottom foundations. Should specialize geomorphology data for bathymetry-specific considerations.

load_moorpy_soil(file_soil)[source]#

Load soil data from a MoorPy soil file.

Experimental: reader may not be able to read validly formatted file in in the presence of unanticipated comments, whitespace, etc.

Parameters:

file_soil (PathLike) -- The path to the soil data file

load_moorpy_bathymetry(file_bathymetry)[source]#

Load bathymetry data from a MoorPy bathymetry grid file.

Experimental: reader may not be able to read validly formatted file in in the presence of unanticipated comments, whitespace, etc.

Parameters:

file_bathymetry (str) -- The path to the bathymetry data file

class ard.geographic.geomorphology.TopographyGridData[source]#

A class to represent gridded terrain data for a given wind farm site domain.

Represents the terrain data for onshore sites. Should specialize geomorphology data for topography-specific considerations.

Contents