`salvus.flow.simple_config.receiver.seismology.collections`

Seismology receiver collections.

Classes

`SideSetGridPoint3D`

class SideSetGridPoint3D(
    salvus.flow.simple_config.receiver._ReceiverCollection
):
    def __init__(
        self,
        lat_center: float,
        lat_extent: float,
        lon_center: float,
        lon_extent: float,
        fields: list[str],
        n_lat: int,
        n_lon: int,
        depth_in_m: float = 0.0,
        network_code: str = "XX",
        station_code_pattern: str = "A{:04}",
        location_code: str = "",
    ) -> None: ...

All the operations on a read-only sequence.

Concrete subclasses must override new or init, getitem, and len.

Create a grid of 3D seismological receivers in spherical coordinates.

The grid will follow a cubed sphere chunk with the same latitude and longitude settings.

All coordinates here are spherical coordinates. If your coordinates are defined in a geodetic (ellipsoidal) reference system like WGS84, you need to convert them before passing them to this function.

Parameters

lat_center float — Latitude center of the receiver grid.
lat_extent float — Latitude extent of the receiver grid.
lon_center float — Longitude center of the receiver grid.
lon_extent float — Longitude extent of the receiver grid.
fields list[str] — Which fields to save for the receivers.
n_lat int — Number of receivers along the latitude side of the grid.
n_lon int — Number of receivers along the longitude side of the grid.
depth_in_m float — Depth of the receivers below Earth’s surface.
network_code str — Station code for all the receivers.
station_code_pattern str — Station code pattern. Will be called with str.format() and the receiver index as the sole argument.
location_code str — Location code for all receivers.

Methods

`to_list()`

def to_list(self) -> list[_Base]: ...

Convert to a list of receivers.

Returns list[_Base]

`SideSetSphericalGridPoint3D`

class SideSetSphericalGridPoint3D(
    salvus.flow.simple_config.receiver._ReceiverCollection
):
    def __init__(
        self,
        lat_center: float,
        lat_extent: float,
        lon_center: float,
        lon_extent: float,
        fields: list[str],
        n_lat: int,
        n_lon: int,
        depth_in_m: float = 0.0,
        network_code: str = "XX",
        station_code_pattern: str = "A{:04}",
        location_code: str = "",
        use_side_set_receivers: bool = True,
    ) -> None: ...

All the operations on a read-only sequence.

Concrete subclasses must override new or init, getitem, and len.

Create a grid of 3D seismological receivers in spherical coordinates.

In contrast to SideSetSphericalPoint3D, this collection returns receivers which are equidistantly spaced in spherical coordinates.

All coordinates here are spherical coordinates. If your coordinates are defined in a geodetic (ellipsoidal) reference system like WGS84, you need to convert them before passing them to this function.

Parameters

lat_center float — Latitude center of the receiver grid.
lat_extent float — Latitude extent of the receiver grid.
lon_center float — Longitude center of the receiver grid.
lon_extent float — Longitude extent of the receiver grid.
fields list[str] — Which fields to save for the receivers.
n_lat int — Number of receivers along the latitude side of the grid.
n_lon int — Number of receivers along the longitude side of the grid.
depth_in_m float — Depth of the receivers below Earth’s surface.
network_code str — Station code for all the receivers.
station_code_pattern str — Station code pattern. Will be called with str.format() and the receiver index as the sole argument.
location_code str — Location code for all receivers.
use_side_set_receivers bool — In certain cases it is advantageous to specify receivers in absolute lat/lon/rad, rather than a relative depth below the mesh surface. Setting this parameter to False allows this method of operation.

Methods

`to_list()`

def to_list(self) -> list[_Base]: ...

Convert to a list of receivers.

Returns list[_Base]

`SpherePoint3D`

class SpherePoint3D(salvus.flow.simple_config.receiver._ReceiverCollection):
    def __init__(
        self,
        x: float,
        y: float,
        z: float,
        radius: float,
        count: int,
        fields: list[str],
        network_code: str = "XX",
        station_code_pattern: str = "A{:04}",
        location_code: str = "",
    ) -> None: ...

All the operations on a read-only sequence.

Concrete subclasses must override new or init, getitem, and len.

Create a sphere of Point3D receivers using the Fibonacci algorithm.

Parameters

x float — x-coordinate of the center.
y float — y-coordinate of the center.
z float — z-coordinate of the center.
radius float — Radius of the sphere.
count int — Number or receivers to create.
fields list[str] — Which fields to save for the receivers.
network_code str — Station code for all the receivers.
station_code_pattern str — Station code pattern. Will be called with str.format() and the receiver index as the sole argument.
location_code str — Location code for all receivers.

Methods

`to_list()`

def to_list(self) -> list[_Base]: ...

Convert to a list of receivers.

Returns list[_Base]