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

salvus.flow.simple_config.receiver.seismology.collections

salvus.flow.simple_config.receiver.seismology.collections salvus flow simple_config receiver seismology collections
Seismology receiver collections.

Classes

SideSetGridPoint3D

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.
SIGNATURE
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: ...
ARGUMENTS
Required
lat_center
Type:float
Description:
Latitude center of the receiver grid.
Required
lat_extent
Type:float
Description:
Latitude extent of the receiver grid.
Required
lon_center
Type:float
Description:
Longitude center of the receiver grid.
Required
lon_extent
Type:float
Description:
Longitude extent of the receiver grid.
Required
fields
Type:list[str]
Description:
Which fields to save for the receivers.
Required
n_lat
Type:int
Description:
Number of receivers along the latitude side of the grid.
Required
n_lon
Type:int
Description:
Number of receivers along the longitude side of the grid.
Optional
depth_in_m
Type:float
Default value:0.0
Description:
Depth of the receivers below Earth's surface.
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

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

SideSetSphericalGridPoint3D

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.
SIGNATURE
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: ...
ARGUMENTS
Required
lat_center
Type:float
Description:
Latitude center of the receiver grid.
Required
lat_extent
Type:float
Description:
Latitude extent of the receiver grid.
Required
lon_center
Type:float
Description:
Longitude center of the receiver grid.
Required
lon_extent
Type:float
Description:
Longitude extent of the receiver grid.
Required
fields
Type:list[str]
Description:
Which fields to save for the receivers.
Required
n_lat
Type:int
Description:
Number of receivers along the latitude side of the grid.
Required
n_lon
Type:int
Description:
Number of receivers along the longitude side of the grid.
Optional
depth_in_m
Type:float
Default value:0.0
Description:
Depth of the receivers below Earth's surface.
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.
Optional
use_side_set_receivers
Type:bool
Default value:True
Description:
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

SideSetSphericalGridPoint3D.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 = "",
    ) -> None: ...
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.
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
seismology
Next
cartesian
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