Mondaic Documentation
www.mondaic.com
Mondaic
Version:
No results found.
python_api
/
salvus
/
flow
/
simple_config
/
receiver
/
cartesian
/
collections

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

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.
SIGNATURE
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 = "",
    ): ...
ARGUMENTS
Required
x
Type:float | np.ndarray
Description:
X-coordinates
Required
y
Type:float | np.ndarray
Description:
Y-coordinates
Required
fields
Type:list[str]
Description:
Fields to store.
Optional
network_code
Type:str
Default value:'XX'
Description:
Network code.
Optional
station_code_pattern
Type:str
Default value:'A{:04}'
Description:
Station code pattern.
Optional
location_code
Type:str
Default value:''
Description:
Location code.

Methods

ArrayPoint2D.to_list()
Convert to a list of receivers.
SIGNATURE
def to_list(self) -> list[_Base]: ...

RingPoint2D

All the operations on a read-only sequence.
Concrete subclasses must override new or init, getitem, and len.
Create a ring of Point2D receivers.
SIGNATURE
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 = "",
    ): ...
ARGUMENTS
Required
x
Type:float
Description:
x-coordinate of the center.
Required
y
Type:float
Description:
y-coordinate of the center.
Required
radius
Type:float
Description:
Radius of the ring in meters.
Required
count
Type:int
Description:
Number or receivers to create.
Required
fields
Type:list[str]
Description:
Which fields to save for the receivers.
Optional
network_code
Type:str
Default value:'XX'
Description:
Station code for all the receivers.
Optional
station_code_pattern
Type:str
Default value:'A{:04}'
Description:
Station code pattern. Will be called with str.format() and the receiver index as the sole argument.
Optional
location_code
Type:str
Default value:''
Description:
Location code for all receivers.

Methods

RingPoint2D.to_list()
Convert to a list of receivers.
SIGNATURE
def to_list(self) -> list[_Base]: ...

RingPoint3D

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.
SIGNATURE
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 = "",
    ): ...
ARGUMENTS
Required
x
Type:float
Description:
x-coordinate of the center.
Required
y
Type:float
Description:
y-coordinate of the center.
Required
z
Type:float
Description:
z-coordinate for the elevation of the ring.
Required
radius
Type:float
Description:
Radius of the ring in meters.
Required
count
Type:int
Description:
Number or receivers to create.
Required
fields
Type:list[str]
Description:
Which fields to save for the receivers.
Optional
network_code
Type:str
Default value:'XX'
Description:
Station code for all the receivers.
Optional
station_code_pattern
Type:str
Default value:'A{:04}'
Description:
Station code pattern. Will be called with str.format() and the receiver index as the sole argument.
Optional
location_code
Type:str
Default value:''
Description:
Location code for all receivers.

Methods

RingPoint3D.to_list()
Convert to a list of receivers.
SIGNATURE
def to_list(self) -> list[_Base]: ...

RingsOnSpherePoint3D

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.
SIGNATURE
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 = "",
    ): ...
ARGUMENTS
Required
x
Type:float
Description:
x-coordinate of the center.
Required
y
Type:float
Description:
y-coordinate of the center.
Required
z
Type:float
Description:
z-coordinate of the center.
Required
radius
Type:float
Description:
Radius of the ring in meters.
Required
elevations
Type:list[float]
Description:
z-elevations of the ring.
Required
spacing_in_meters
Type:float
Description:
approximate horizontal spacing between the receivers.
Required
fields
Type:list[str]
Description:
Which fields to save for the receivers.
Optional
network_code
Type:str
Default value:'XX'
Description:
Station code for all the receivers.
Optional
station_code_pattern
Type:str
Default value:'A{:04}'
Description:
Station code pattern. Will be called with str.format() and the receiver index as the sole argument.
Optional
location_code
Type:str
Default value:''
Description:
Location code for all receivers.

Methods

RingsOnSpherePoint3D.to_list()
Convert to a list of receivers.
SIGNATURE
def to_list(self) -> list[_Base]: ...

SideSetArrayPoint3D

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

Methods

SideSetArrayPoint3D.to_list()
Convert to a list of receivers.
SIGNATURE
def to_list(self) -> list[_Base]: ...

SpherePoint3D

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.
SIGNATURE
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 = "",
    ): ...
ARGUMENTS
Required
x
Type:float
Description:
x-coordinate of the center.
Required
y
Type:float
Description:
y-coordinate of the center.
Required
z
Type:float
Description:
z-coordinate of the center.
Required
radius
Type:float
Description:
Radius of the sphere in meters.
Required
count
Type:int
Description:
Number or receivers to create.
Required
fields
Type:list[str]
Description:
Which fields to save for the receivers.
Optional
network_code
Type:str
Default value:'XX'
Description:
Station code for all the receivers.
Optional
station_code_pattern
Type:str
Default value:'A{:04}'
Description:
Station code pattern. Will be called with str.format() and the receiver index as the sole argument.
Optional
location_code
Type:str
Default value:''
Description:
Location code for all receivers.

Methods

SpherePoint3D.to_list()
Convert to a list of receivers.
SIGNATURE
def to_list(self) -> list[_Base]: ...
Previous
cartesian
Next
simulation
We use cookies to analyze our traffic, but won't track you until explicit consent is given. Using our contact form will create relevant cookies and transmit data to third party services to keep track of your request. Read more about how we use personal information in our Privacy Policy.
PAGE CONTENTS