Mondaic

salvus.flow.simple_config.receiver.cartesian.collections

salvus.flow.simple_config.receiver.cartesian.collections salvus flow simple_config receiver cartesian collections

Cartesian receiver collections.

Classes

ArrayPoint2D

class ArrayPoint2D(salvus.flow.simple_config.receiver._ReceiverCollection):
    def __init__(
        self,
        x: float | np.ndarray,
        y: float | np.ndarray,
        fields: list[str],
        network_code: str = "XX",
        station_code_pattern: str = "A{:04}",
        location_code: str = "",
    ): ...

All the operations on a read-only sequence.

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

Create an array of 2D point receivers given x and y coordinates.

Parameters
  • x float | np.ndarray — X-coordinates
  • y float | np.ndarray — Y-coordinates
  • fields list[str] — Fields to store.
  • network_code str — Network code.
  • station_code_pattern str — Station code pattern.
  • location_code str — Location code.
Methods
to_list()
def to_list(self) -> list[_Base]: ...

Convert to a list of receivers.

Returns list[_Base]

RingPoint2D

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

All the operations on a read-only sequence.

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

Create a ring of Point2D receivers.

Parameters
  • x float — x-coordinate of the center.
  • y float — y-coordinate of the center.
  • radius float — Radius of the ring in meters.
  • 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]

RingPoint3D

class RingPoint3D(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 = "",
    ): ...

All the operations on a read-only sequence.

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

Create a ring of Point3D receivers in the x-y-plane at a fixed elevation in the z direction.

Parameters
  • x float — x-coordinate of the center.
  • y float — y-coordinate of the center.
  • z float — z-coordinate for the elevation of the ring.
  • radius float — Radius of the ring in meters.
  • 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]

RingsOnSpherePoint3D

class RingsOnSpherePoint3D(
    salvus.flow.simple_config.receiver._ReceiverCollection
):
    def __init__(
        self,
        x: float,
        y: float,
        z: float,
        radius: float,
        elevations: list[float],
        spacing_in_meters: float,
        fields: list[str],
        network_code: str = "XX",
        station_code_pattern: str = "A{:04}",
        location_code: str = "",
    ): ...

All the operations on a read-only sequence.

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

Create a spherical aperture with Point3D receivers aligned on rings at different elevations of the sphere. The number of receivers per elevation is determined based on the spacing in meters.

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 ring in meters.
  • elevations list[float] — z-elevations of the ring.
  • spacing_in_meters float — approximate horizontal spacing between the receivers.
  • 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]

SideSetArrayPoint3D

class SideSetArrayPoint3D(
    salvus.flow.simple_config.receiver._ReceiverCollection
):
    def __init__(
        self,
        x: np.ndarray,
        y: np.ndarray,
        depth_in_meters: float,
        fields: list[str],
        network_code: str = "XX",
        station_code_pattern: str = "A{:04}",
        location_code: str = "",
    ): ...

All the operations on a read-only sequence.

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

Create a 2-D array of point receivers appropriate for 3-D simulations.

Internally this function will create a meshgrid-like array of receivers, spanned by the 1-D x and y coordinate arrays. Receivers will be buried depth meters below the "z1" side set (which generally represents the surface in a 3-D Cartesian mesh).

Parameters
  • x np.ndarray — 1-D array of x coordinates.
  • y np.ndarray — 1-D array of y coordinates.
  • depth_in_meters float — Depth of the receivers below the z1 side set.
  • fields list[str] — Fields that the receivers should save.
  • network_code str — Network code. Defaults to “XX”.
  • station_code_pattern str — Station code pattern. Defaults to “A{:04}”.
  • location_code str — Location code. Defaults to "".
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 = "",
    ): ...

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 in meters.
  • 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]

Used in tutorials