Mondaic DocumentationRequired
filename_or_obj| Type: | typing.Any |
| Description: | Filename/URL/Python object |
Version:
2026.5.0
Salvus documentation version
2026.5.0
2025.1.3
2024.1.3
0.12.16
No results found.
salvus.flow.simple_config.source.seismology
salvus.flow.simple_config.source.seismology salvus flow simple_config source seismologySources in a seismological context.
Specifically this means:
- Coordinates are specified in latitude, longitude, and burial beneath the surface.
- Moment tensors and vector sources are specified in spherical r, theta, and phi coordinates. This corresponds to radial, colatitudinal, and longitudinal directions. This is also know has the Harvard convention for moment tensors.
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.
For 2D the latitude will ignored and only the longitude will be assumed. This
is the default polar coordinate system with:
x = r * cos(phi)y = r * sin(phi)
phi is the longitude here.Functions
parse()
Attempts to parse anything to a list of either
:class:
.SideSetMomentTensorPoint2D or
:class:.SideSetMomentTensorPoint3D objects.Supports pretty much everything ObsPy supports, ranging from QuakeML
data, over CMTSOLUTION and ndk files to ObsPy's custom objects from
filenames, URLs, memory files, ...
Coordinates, by default, are assumed to be defined on the WGS84 ellipsoid
and will be converted to geocentric coordinates. This can be influenced
with the
axes_a_b parameter.SIGNATURE
def parse(
filename_or_obj: typing.Any,
dimensions: int,
side_set_name: str = "r1",
source_time_function: salvus.flow.simple_config.stf._Base | None = None,
axes_a_b: tuple[float, float] = (6378137.0, 6356752.314245),
) -> list[SideSetMomentTensorPoint2D | SideSetMomentTensorPoint3D]: ...ARGUMENTS
Required
dimensions| Type: | int |
| Description: | Determines if the function returns 2D or 3D moment tensor sources. |
Optional
side_set_name| Type: | str |
| Default value: | 'r1' |
| Description: | Name of the side set the sources will be attached to. The default is likely good. |
Optional
source_time_function| Type: | salvus.flow.simple_config.stf._Base | None |
| Default value: | None |
| Description: | A source in Salvus always requires a source time function and the information in the files is never enough to reconstruct it. It can already be specified here - if not it still must be set before a simulation is run. |
Optional
axes_a_b| Type: | tuple[float, float] |
| Default value: | (6378137.0, 6356752.314245) |
| Description: | Assumed ellipticity of the planet used for converting the latitude. Defaults to the values for the WGS84 ellipsoid. |
RETURNS
Return type:
list[SideSetMomentTensorPoint2D | SideSetMomentTensorPoint3D]A list of locatable side set sources.
Classes
MomentTensorPoint2D
Seismological 2-D moment tensor source.
SIGNATURE
class MomentTensorPoint2D(
salvus.flow.simple_config.coordinate_system_utils._SeismologyBase,
salvus.flow.simple_config.source._BaseSource,
):
def __init__(
self,
longitude: float,
depth_in_m: float = 0.0,
radius_of_sphere_in_m: float = 6371000.0,
mrr: float,
mpp: float,
mrp: float,
source_time_function: "salvus.flow.simple_config.stf._Base | None" = None,
rotation_on_input: "dict | None" = None,
reference_time_utc_string: Optional[str] = None,
): ...ARGUMENTS
Required
longitude| Type: | float |
| Description: | The longitude in degree. |
Optional
depth_in_m| Type: | float |
| Default value: | 0.0 |
| Description: | The depth in meters of the receiver. |
Optional
radius_of_sphere_in_m| Type: | float |
| Default value: | 6371000.0 |
| Description: | This class assumes a perfect sphere to derive the cartesian coordinates of the receiver. This is the radius of that sphere. |
Required
mrr| Type: | float |
| Description: | RR component of the moment in Nm. |
Required
mpp| Type: | float |
| Description: | PP component of the moment in Nm. |
Required
mrp| Type: | float |
| Description: | RP component of the moment in Nm. |
Optional
source_time_function| Type: | 'salvus.flow.simple_config.stf._Base | None' |
| Default value: | None |
| Description: | Source time function. |
Optional
rotation_on_input| Type: | 'dict | None' |
| Default value: | None |
| Description: | Transform the input STF according to this matrix. |
Optional
reference_time_utc_string| Type: | Optional[str] |
| Default value: | None |
| Description: | Reference time for the source. Usually equal to the origin time. If it is set, the reference time for whole simulation will be set to this time. |
MomentTensorPoint3D
Seismological 3-D moment tensor source.
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 MomentTensorPoint3D(
salvus.flow.simple_config.coordinate_system_utils._SeismologyBase,
salvus.flow.simple_config.source._BaseSource,
):
def __init__(
self,
latitude: float,
longitude: float,
depth_in_m: float = 0.0,
radius_of_sphere_in_m: float = 6371000.0,
mrr: float,
mtt: float,
mpp: float,
mtp: float,
mrp: float,
mrt: float,
source_time_function: "salvus.flow.simple_config.stf._Base | None" = None,
rotation_on_input: "dict | None" = None,
reference_time_utc_string: Optional[str] = None,
): ...ARGUMENTS
Required
latitude| Type: | float |
| Description: | The latitude in degrees. |
Required
longitude| Type: | float |
| Description: | The longitude in degrees. |
Optional
depth_in_m| Type: | float |
| Default value: | 0.0 |
| Description: | The depth in meters of the receiver. |
Optional
radius_of_sphere_in_m| Type: | float |
| Default value: | 6371000.0 |
| Description: | This class assumes a perfect sphere to derive the cartesian coordinates of the receiver. This is the radius of that sphere. |
Required
mrr| Type: | float |
| Description: | RR component of the moment in Nm. |
Required
mtt| Type: | float |
| Description: | TT component of the moment in Nm. |
Required
mpp| Type: | float |
| Description: | PP component of the moment in Nm. |
Required
mtp| Type: | float |
| Description: | TP component of the moment in Nm. |
Required
mrp| Type: | float |
| Description: | RP component of the moment in Nm. |
Required
mrt| Type: | float |
| Description: | RT component of the moment in Nm. |
Optional
source_time_function| Type: | 'salvus.flow.simple_config.stf._Base | None' |
| Default value: | None |
| Description: | Source time function. |
Optional
rotation_on_input| Type: | 'dict | None' |
| Default value: | None |
| Description: | Transform the input STF according to this matrix. |
Optional
reference_time_utc_string| Type: | Optional[str] |
| Default value: | None |
| Description: | Reference time for the source. Usually equal to the origin time. If it is set, the reference time for whole simulation will be set to this time. |
ScalarGradientPoint2D
Seismological scalar gradient 2-D source.
SIGNATURE
class ScalarGradientPoint2D(
salvus.flow.simple_config.coordinate_system_utils._SeismologyBase,
salvus.flow.simple_config.source._BaseSource,
):
def __init__(
self,
longitude: float,
depth_in_m: float = 0.0,
radius_of_sphere_in_m: float = 6371000.0,
fr: float,
fp: float,
source_time_function: "salvus.flow.simple_config.stf._Base | None" = None,
rotation_on_input: "dict | None" = None,
reference_time_utc_string: Optional[str] = None,
): ...ARGUMENTS
Required
longitude| Type: | float |
| Description: | The longitude in degree. |
Optional
depth_in_m| Type: | float |
| Default value: | 0.0 |
| Description: | The depth in meters of the receiver. |
Optional
radius_of_sphere_in_m| Type: | float |
| Default value: | 6371000.0 |
| Description: | This class assumes a perfect sphere to derive the cartesian coordinates of the receiver. This is the radius of that sphere. |
Required
fr| Type: | float |
| Description: | Force amplitude scaling factor of the radial component. |
Required
fp| Type: | float |
| Description: | Force amplitude scaling factor of the phi component. |
Optional
source_time_function| Type: | 'salvus.flow.simple_config.stf._Base | None' |
| Default value: | None |
| Description: | Source time function. |
Optional
rotation_on_input| Type: | 'dict | None' |
| Default value: | None |
| Description: | Transform the input STF according to this matrix. |
Optional
reference_time_utc_string| Type: | Optional[str] |
| Default value: | None |
| Description: | Reference time for the source. Usually equal to the origin time. If it is set, the reference time for whole simulation will be set to this time. |
ScalarGradientPoint3D
Seismological scalar gradient 2-D source.
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 ScalarGradientPoint3D(
salvus.flow.simple_config.coordinate_system_utils._SeismologyBase,
salvus.flow.simple_config.source._BaseSource,
):
def __init__(
self,
latitude: float,
longitude: float,
depth_in_m: float = 0.0,
radius_of_sphere_in_m: float = 6371000.0,
fr: float,
ft: float,
fp: float,
source_time_function: "salvus.flow.simple_config.stf._Base | None" = None,
rotation_on_input: "dict | None" = None,
reference_time_utc_string: Optional[str] = None,
): ...ARGUMENTS
Required
latitude| Type: | float |
| Description: | The latitude in degrees. |
Required
longitude| Type: | float |
| Description: | The longitude in degree. |
Optional
depth_in_m| Type: | float |
| Default value: | 0.0 |
| Description: | The depth in meters of the receiver. |
Optional
radius_of_sphere_in_m| Type: | float |
| Default value: | 6371000.0 |
| Description: | This class assumes a perfect sphere to derive the cartesian coordinates of the receiver. This is the radius of that sphere. |
Required
fr| Type: | float |
| Description: | Force amplitude scaling factor of the radial component. |
Required
ft| Type: | float |
| Description: | Force amplitude scaling factor of the theta component. |
Required
fp| Type: | float |
| Description: | Force amplitude scaling factor of the phi component. |
Optional
source_time_function| Type: | 'salvus.flow.simple_config.stf._Base | None' |
| Default value: | None |
| Description: | Source time function. |
Optional
rotation_on_input| Type: | 'dict | None' |
| Default value: | None |
| Description: | Transform the input STF according to this matrix. |
Optional
reference_time_utc_string| Type: | Optional[str] |
| Default value: | None |
| Description: | Reference time for the source. Usually equal to the origin time. If it is set, the reference time for whole simulation will be set to this time. |
ScalarPoint2D
Seismological scalar 2-D source.
SIGNATURE
class ScalarPoint2D(
salvus.flow.simple_config.coordinate_system_utils._SeismologyBase,
salvus.flow.simple_config.source._BaseSource,
):
def __init__(
self,
longitude: float,
depth_in_m: float = 0.0,
radius_of_sphere_in_m: float = 6371000.0,
f: "float",
source_time_function: "salvus.flow.simple_config.stf._Base | None" = None,
reference_time_utc_string: Optional[str] = None,
): ...ARGUMENTS
Required
longitude| Type: | float |
| Description: | The longitude in degree. |
Optional
depth_in_m| Type: | float |
| Default value: | 0.0 |
| Description: | The depth in meters of the receiver. |
Optional
radius_of_sphere_in_m| Type: | float |
| Default value: | 6371000.0 |
| Description: | This class assumes a perfect sphere to derive the cartesian coordinates of the receiver. This is the radius of that sphere. |
Required
f| Type: | 'float' |
| Description: | Force of the source in Nm. |
Optional
source_time_function| Type: | 'salvus.flow.simple_config.stf._Base | None' |
| Default value: | None |
| Description: | Source time function. |
Optional
reference_time_utc_string| Type: | Optional[str] |
| Default value: | None |
| Description: | Reference time for the source. Usually equal to the origin time. If it is set, the reference time for whole simulation will be set to this time. |
ScalarPoint3D
Seismological 3-D scalar source.
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 ScalarPoint3D(
salvus.flow.simple_config.coordinate_system_utils._SeismologyBase,
salvus.flow.simple_config.source._BaseSource,
):
def __init__(
self,
latitude: float,
longitude: float,
depth_in_m: float = 0.0,
radius_of_sphere_in_m: float = 6371000.0,
f: "float",
source_time_function: "salvus.flow.simple_config.stf._Base | None" = None,
reference_time_utc_string: Optional[str] = None,
): ...ARGUMENTS
Required
latitude| Type: | float |
| Description: | The latitude in degree. |
Required
longitude| Type: | float |
| Description: | The longitude in degree. |
Optional
depth_in_m| Type: | float |
| Default value: | 0.0 |
| Description: | The depth in meters of the receiver. |
Optional
radius_of_sphere_in_m| Type: | float |
| Default value: | 6371000.0 |
| Description: | This class assumes a perfect sphere to derive the cartesian coordinates of the receiver. This is the radius of that sphere. |
Required
f| Type: | 'float' |
| Description: | Force of the source in Nm. |
Optional
source_time_function| Type: | 'salvus.flow.simple_config.stf._Base | None' |
| Default value: | None |
| Description: | Source time function. |
Optional
reference_time_utc_string| Type: | Optional[str] |
| Default value: | None |
| Description: | Reference time for the source. Usually equal to the origin time. If it is set, the reference time for whole simulation will be set to this time. |
SideSetMomentTensorPoint2D
Seismological 2-D moment tensor side-set source.
SIGNATURE
class SideSetMomentTensorPoint2D(
salvus.flow.simple_config.coordinate_system_utils._SeismologyBase,
salvus.flow.simple_config.source.cartesian.SideSetMomentTensorPoint2D,
):
def __init__(
self,
longitude: float,
depth_in_m: float = 0.0,
radius_of_sphere_in_m: float = 6371000.0,
mrr: float,
mpp: float,
mrp: float,
side_set_name: str,
source_time_function: "'salvus.flow.simple_config.stf._Base | None'" = None,
rotation_on_input: "'dict | None'" = None,
reference_time_utc_string: Optional[str] = None,
): ...ARGUMENTS
Required
longitude| Type: | float |
| Description: | The longitude in degree. |
Optional
depth_in_m| Type: | float |
| Default value: | 0.0 |
| Description: | The depth in meters of the receiver below the specified side set. |
Optional
radius_of_sphere_in_m| Type: | float |
| Default value: | 6371000.0 |
| Description: | Planet radius used for the initial guess of the receiver. Can be a really rough estimate. |
Required
mrr| Type: | float |
| Description: | RR component of the moment in Nm. |
Required
mpp| Type: | float |
| Description: | PP component of the moment in Nm. |
Required
mrp| Type: | float |
| Description: | RP component of the moment in Nm. |
Required
side_set_name| Type: | str |
| Description: | Name of the side at which to place the receiver. |
Optional
source_time_function| Type: | "'salvus.flow.simple_config.stf._Base | None'" |
| Default value: | None |
| Description: | Source time function. |
Optional
rotation_on_input| Type: | "'dict | None'" |
| Default value: | None |
| Description: | Transform the input STF according to this matrix. |
Optional
reference_time_utc_string| Type: | Optional[str] |
| Default value: | None |
| Description: | Reference time for the source. Usually equal to the origin time. If it is set, the reference time for whole simulation will be set to this time. |
SideSetMomentTensorPoint3D
Seismological 3-D moment tensor side-set source.
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 SideSetMomentTensorPoint3D(
salvus.flow.simple_config.coordinate_system_utils._SeismologyBase,
salvus.flow.simple_config.source.cartesian.SideSetMomentTensorPoint3D,
):
def __init__(
self,
latitude: float,
longitude: float,
depth_in_m: float = 0.0,
radius_of_sphere_in_m: float = 6371000.0,
mrr: float,
mtt: float,
mpp: float,
mtp: float,
mrp: float,
mrt: float,
side_set_name: str,
source_time_function: "'salvus.flow.simple_config.stf._Base | None'" = None,
rotation_on_input: "'dict | None'" = None,
reference_time_utc_string: Optional[str] = None,
): ...ARGUMENTS
Required
latitude| Type: | float |
| Description: | The latitude in degrees. |
Required
longitude| Type: | float |
| Description: | The longitude in degrees. |
Optional
depth_in_m| Type: | float |
| Default value: | 0.0 |
| Description: | The depth in meters of the receiver below the specified side set. |
Optional
radius_of_sphere_in_m| Type: | float |
| Default value: | 6371000.0 |
| Description: | Planet radius used for the initial guess of the receiver. Can be a really rough estimate. |
Required
mrr| Type: | float |
| Description: | RR component of the moment in Nm. |
Required
mtt| Type: | float |
| Description: | TT component of the moment in Nm. |
Required
mpp| Type: | float |
| Description: | PP component of the moment in Nm. |
Required
mtp| Type: | float |
| Description: | TP component of the moment in Nm. |
Required
mrp| Type: | float |
| Description: | RP component of the moment in Nm. |
Required
mrt| Type: | float |
| Description: | RT component of the moment in Nm. |
Required
side_set_name| Type: | str |
| Description: | Name of the side at which to place the receiver. |
Optional
source_time_function| Type: | "'salvus.flow.simple_config.stf._Base | None'" |
| Default value: | None |
| Description: | Source time function. |
Optional
rotation_on_input| Type: | "'dict | None'" |
| Default value: | None |
| Description: | Transform the input STF according to this matrix. |
Optional
reference_time_utc_string| Type: | Optional[str] |
| Default value: | None |
| Description: | Reference time for the source. Usually equal to the origin time. If it is set, the reference time for whole simulation will be set to this time. |
SideSetScalarGradientPoint2D
Seismological 2-D scalar side-set source.
SIGNATURE
class SideSetScalarGradientPoint2D(
salvus.flow.simple_config.coordinate_system_utils._SeismologyBase,
salvus.flow.simple_config.source.cartesian.SideSetScalarPoint2D,
):
def __init__(
self,
longitude: float,
depth_in_m: float = 0.0,
radius_of_sphere_in_m: float = 6371000.0,
fr: float,
fp: float,
side_set_name: str,
source_time_function: "'salvus.flow.simple_config.stf._Base | None'" = None,
rotation_on_input: "'dict | None'" = None,
reference_time_utc_string: Optional[str] = None,
): ...ARGUMENTS
Required
longitude| Type: | float |
| Description: | The longitude in degree. |
Optional
depth_in_m| Type: | float |
| Default value: | 0.0 |
| Description: | The depth in meters of the receiver below the specified side set. |
Optional
radius_of_sphere_in_m| Type: | float |
| Default value: | 6371000.0 |
| Description: | Planet radius used for the initial guess of the receiver. Can be a really rough estimate. |
Required
fr| Type: | float |
| Description: | Force amplitude scaling factor of the radial component. |
Required
fp| Type: | float |
| Description: | Force amplitude scaling factor of the phi component. |
Required
side_set_name| Type: | str |
| Description: | Name of the side at which to place the receiver. |
Optional
source_time_function| Type: | "'salvus.flow.simple_config.stf._Base | None'" |
| Default value: | None |
| Description: | Source time function. |
Optional
rotation_on_input| Type: | "'dict | None'" |
| Default value: | None |
| Description: | Transform the input STF according to this matrix. |
Optional
reference_time_utc_string| Type: | Optional[str] |
| Default value: | None |
| Description: | Reference time for the source. Usually equal to the origin time. If it is set, the reference time for whole simulation will be set to this time. |
SideSetScalarGradientPoint3D
Seismological 3-D scalar gradient side-set source.
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 SideSetScalarGradientPoint3D(
salvus.flow.simple_config.coordinate_system_utils._SeismologyBase,
salvus.flow.simple_config.source.cartesian.SideSetScalarPoint3D,
):
def __init__(
self,
latitude: float,
longitude: float,
depth_in_m: float = 0.0,
radius_of_sphere_in_m: float = 6371000.0,
fr: float,
ft: float,
fp: float,
side_set_name: str,
source_time_function: "'salvus.flow.simple_config.stf._Base | None'" = None,
rotation_on_input: "'dict | None'" = None,
reference_time_utc_string: Optional[str] = None,
): ...ARGUMENTS
Required
latitude| Type: | float |
| Description: | The latitude in degrees. |
Required
longitude| Type: | float |
| Description: | The longitude in degrees. |
Optional
depth_in_m| Type: | float |
| Default value: | 0.0 |
| Description: | The depth in meters of the receiver below the specified side set. |
Optional
radius_of_sphere_in_m| Type: | float |
| Default value: | 6371000.0 |
| Description: | Planet radius used for the initial guess of the receiver. Can be a really rough estimate. |
Required
fr| Type: | float |
| Description: | Force amplitude scaling factor of the radial component. |
Required
ft| Type: | float |
| Description: | Force amplitude scaling factor of the theta component. |
Required
fp| Type: | float |
| Description: | Force amplitude scaling factor of the phi component. |
Required
side_set_name| Type: | str |
| Description: | Name of the side at which to place the receiver. |
Optional
source_time_function| Type: | "'salvus.flow.simple_config.stf._Base | None'" |
| Default value: | None |
| Description: | Source time function. |
Optional
rotation_on_input| Type: | "'dict | None'" |
| Default value: | None |
| Description: | Transform the input STF according to this matrix. |
Optional
reference_time_utc_string| Type: | Optional[str] |
| Default value: | None |
| Description: | Reference time for the source. Usually equal to the origin time. If it is set, the reference time for whole simulation will be set to this time. |
SideSetScalarPoint2D
Seismological 2-D scalar side-set source.
SIGNATURE
class SideSetScalarPoint2D(
salvus.flow.simple_config.coordinate_system_utils._SeismologyBase,
salvus.flow.simple_config.source.cartesian.SideSetScalarPoint2D,
):
def __init__(
self,
longitude: float,
depth_in_m: float = 0.0,
radius_of_sphere_in_m: float = 6371000.0,
side_set_name: str,
f: "'float'",
source_time_function: "'salvus.flow.simple_config.stf._Base | None'" = None,
reference_time_utc_string: Optional[str] = None,
): ...ARGUMENTS
Required
longitude| Type: | float |
| Description: | The longitude in degree. |
Optional
depth_in_m| Type: | float |
| Default value: | 0.0 |
| Description: | The depth in meters of the receiver below the specified side set. |
Optional
radius_of_sphere_in_m| Type: | float |
| Default value: | 6371000.0 |
| Description: | Planet radius used for the initial guess of the receiver. Can be a really rough estimate. |
Required
side_set_name| Type: | str |
| Description: | Name of the side at which to place the receiver. |
Required
f| Type: | "'float'" |
| Description: | Force of the source in Nm. |
Optional
source_time_function| Type: | "'salvus.flow.simple_config.stf._Base | None'" |
| Default value: | None |
| Description: | Source time function. |
Optional
reference_time_utc_string| Type: | Optional[str] |
| Default value: | None |
| Description: | Reference time for the source. Usually equal to the origin time. If it is set, the reference time for whole simulation will be set to this time. |
SideSetScalarPoint3D
Seismological 3-D scalar side-set source.
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 SideSetScalarPoint3D(
salvus.flow.simple_config.coordinate_system_utils._SeismologyBase,
salvus.flow.simple_config.source.cartesian.SideSetScalarPoint3D,
):
def __init__(
self,
latitude: float,
longitude: float,
depth_in_m: float = 0.0,
radius_of_sphere_in_m: float = 6371000.0,
side_set_name: str,
f: "'float'",
source_time_function: "'salvus.flow.simple_config.stf._Base | None'" = None,
reference_time_utc_string: Optional[str] = None,
): ...ARGUMENTS
Required
latitude| Type: | float |
| Description: | The latitude in degrees. |
Required
longitude| Type: | float |
| Description: | The longitude in degrees. |
Optional
depth_in_m| Type: | float |
| Default value: | 0.0 |
| Description: | The depth in meters of the receiver below the specified side set. |
Optional
radius_of_sphere_in_m| Type: | float |
| Default value: | 6371000.0 |
| Description: | Planet radius used for the initial guess of the receiver. Can be a really rough estimate. |
Required
side_set_name| Type: | str |
| Description: | Name of the side at which to place the receiver. |
Required
f| Type: | "'float'" |
| Description: | Force of the source in Nm. |
Optional
source_time_function| Type: | "'salvus.flow.simple_config.stf._Base | None'" |
| Default value: | None |
| Description: | Source time function. |
Optional
reference_time_utc_string| Type: | Optional[str] |
| Default value: | None |
| Description: | Reference time for the source. Usually equal to the origin time. If it is set, the reference time for whole simulation will be set to this time. |
SideSetVectorGradientPoint2D
Seismological 2-D vector gradient side-set source.
SIGNATURE
class SideSetVectorGradientPoint2D(
salvus.flow.simple_config.coordinate_system_utils._SeismologyBase,
salvus.flow.simple_config.source.cartesian.SideSetVectorGradientPoint2D,
):
def __init__(
self,
longitude: float,
depth_in_m: float = 0.0,
radius_of_sphere_in_m: float = 6371000.0,
grr: float,
grp: float,
gpr: float,
gpp: float,
side_set_name: str,
source_time_function: "'salvus.flow.simple_config.stf._Base | None'" = None,
rotation_on_input: "'dict | None'" = None,
reference_time_utc_string: Optional[str] = None,
): ...ARGUMENTS
Required
longitude| Type: | float |
| Description: | The longitude in degree. |
Optional
depth_in_m| Type: | float |
| Default value: | 0.0 |
| Description: | The depth in meters of the receiver below the specified side set. |
Optional
radius_of_sphere_in_m| Type: | float |
| Default value: | 6371000.0 |
| Description: | Planet radius used for the initial guess of the receiver. Can be a really rough estimate. |
Required
grr| Type: | float |
| Description: | RR component of the gradient. |
Required
grp| Type: | float |
| Description: | RP component of the gradient. |
Required
gpr| Type: | float |
| Description: | PR component of the gradient. |
Required
gpp| Type: | float |
| Description: | PP component of the gradient. |
Required
side_set_name| Type: | str |
| Description: | Name of the side at which to place the receiver. |
Optional
source_time_function| Type: | "'salvus.flow.simple_config.stf._Base | None'" |
| Default value: | None |
| Description: | Source time function. |
Optional
rotation_on_input| Type: | "'dict | None'" |
| Default value: | None |
| Description: | Transform the input STF according to this matrix. |
Optional
reference_time_utc_string| Type: | Optional[str] |
| Default value: | None |
| Description: | Reference time for the source. Usually equal to the origin time. If it is set, the reference time for whole simulation will be set to this time. |
SideSetVectorGradientPoint3D
Seismological 3-D vector gradient side-set source.
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 SideSetVectorGradientPoint3D(
salvus.flow.simple_config.coordinate_system_utils._SeismologyBase,
salvus.flow.simple_config.source.cartesian.SideSetVectorGradientPoint3D,
):
def __init__(
self,
latitude: float,
longitude: float,
depth_in_m: float = 0.0,
radius_of_sphere_in_m: float = 6371000.0,
grr: float,
grt: float,
grp: float,
gtr: float,
gtt: float,
gtp: float,
gpr: float,
gpt: float,
gpp: float,
side_set_name: str,
source_time_function: "'salvus.flow.simple_config.stf._Base | None'" = None,
rotation_on_input: "'dict | None'" = None,
reference_time_utc_string: Optional[str] = None,
): ...ARGUMENTS
Required
latitude| Type: | float |
| Description: | The latitude in degrees. |
Required
longitude| Type: | float |
| Description: | The longitude in degrees. |
Optional
depth_in_m| Type: | float |
| Default value: | 0.0 |
| Description: | The depth in meters of the receiver below the specified side set. |
Optional
radius_of_sphere_in_m| Type: | float |
| Default value: | 6371000.0 |
| Description: | Planet radius used for the initial guess of the receiver. Can be a really rough estimate. |
Required
grr| Type: | float |
| Description: | RR component of the gradient. |
Required
grt| Type: | float |
| Description: | RT component of the gradient. |
Required
grp| Type: | float |
| Description: | RP component of the gradient. |
Required
gtr| Type: | float |
| Description: | TR component of the gradient. |
Required
gtt| Type: | float |
| Description: | TT component of the gradient. |
Required
gtp| Type: | float |
| Description: | TP component of the gradient. |
Required
gpr| Type: | float |
| Description: | PR component of the gradient. |
Required
gpt| Type: | float |
| Description: | PT component of the gradient. |
Required
gpp| Type: | float |
| Description: | PP component of the gradient. |
Required
side_set_name| Type: | str |
| Description: | Name of the side at which to place the receiver. |
Optional
source_time_function| Type: | "'salvus.flow.simple_config.stf._Base | None'" |
| Default value: | None |
| Description: | Source time function. |
Optional
rotation_on_input| Type: | "'dict | None'" |
| Default value: | None |
| Description: | Transform the input STF according to this matrix. |
Optional
reference_time_utc_string| Type: | Optional[str] |
| Default value: | None |
| Description: | Reference time for the source. Usually equal to the origin time. If it is set, the reference time for whole simulation will be set to this time. |
SideSetVectorPoint2D
Seismological 2-D vector side-set source.
SIGNATURE
class SideSetVectorPoint2D(
salvus.flow.simple_config.coordinate_system_utils._SeismologyBase,
salvus.flow.simple_config.source.cartesian.SideSetVectorPoint2D,
):
def __init__(
self,
longitude: float,
depth_in_m: float = 0.0,
radius_of_sphere_in_m: float = 6371000.0,
fr: float,
fp: float,
side_set_name: str,
source_time_function: "'salvus.flow.simple_config.stf._Base | None'" = None,
rotation_on_input: "'dict | None'" = None,
reference_time_utc_string: Optional[str] = None,
): ...ARGUMENTS
Required
longitude| Type: | float |
| Description: | The longitude in degree. |
Optional
depth_in_m| Type: | float |
| Default value: | 0.0 |
| Description: | The depth in meters of the receiver below the specified side set. |
Optional
radius_of_sphere_in_m| Type: | float |
| Default value: | 6371000.0 |
| Description: | Planet radius used for the initial guess of the receiver. Can be a really rough estimate. |
Required
fr| Type: | float |
| Description: | R component of the force in N. |
Required
fp| Type: | float |
| Description: | P component of the force in N. |
Required
side_set_name| Type: | str |
| Description: | Name of the side at which to place the receiver. |
Optional
source_time_function| Type: | "'salvus.flow.simple_config.stf._Base | None'" |
| Default value: | None |
| Description: | Source time function. |
Optional
rotation_on_input| Type: | "'dict | None'" |
| Default value: | None |
| Description: | Transform the input STF according to this matrix. |
Optional
reference_time_utc_string| Type: | Optional[str] |
| Default value: | None |
| Description: | Reference time for the source. Usually equal to the origin time. If it is set, the reference time for whole simulation will be set to this time. |
SideSetVectorPoint3D
Seismological 3-D vector side-set source.
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 SideSetVectorPoint3D(
salvus.flow.simple_config.coordinate_system_utils._SeismologyBase,
salvus.flow.simple_config.source.cartesian.SideSetVectorPoint3D,
):
def __init__(
self,
latitude: float,
longitude: float,
depth_in_m: float = 0.0,
radius_of_sphere_in_m: float = 6371000.0,
fr: float,
ft: float,
fp: float,
side_set_name: str,
source_time_function: "'salvus.flow.simple_config.stf._Base | None'" = None,
rotation_on_input: "'dict | None'" = None,
reference_time_utc_string: Optional[str] = None,
): ...ARGUMENTS
Required
latitude| Type: | float |
| Description: | The latitude in degrees. |
Required
longitude| Type: | float |
| Description: | The longitude in degrees. |
Optional
depth_in_m| Type: | float |
| Default value: | 0.0 |
| Description: | The depth in meters of the receiver below the specified side set. |
Optional
radius_of_sphere_in_m| Type: | float |
| Default value: | 6371000.0 |
| Description: | Planet radius used for the initial guess of the receiver. Can be a really rough estimate. |
Required
fr| Type: | float |
| Description: | R component of the force in N. |
Required
ft| Type: | float |
| Description: | T component of the force in N. |
Required
fp| Type: | float |
| Description: | P component of the force in N. |
Required
side_set_name| Type: | str |
| Description: | Name of the side at which to place the receiver. |
Optional
source_time_function| Type: | "'salvus.flow.simple_config.stf._Base | None'" |
| Default value: | None |
| Description: | Source time function. |
Optional
rotation_on_input| Type: | "'dict | None'" |
| Default value: | None |
| Description: | Transform the input STF according to this matrix. |
Optional
reference_time_utc_string| Type: | Optional[str] |
| Default value: | None |
| Description: | Reference time for the source. Usually equal to the origin time. If it is set, the reference time for whole simulation will be set to this time. |
SideSetVectorPoint3DZNE
Seismological 3-D vector side-set source.
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 SideSetVectorPoint3DZNE(
salvus.flow.simple_config.coordinate_system_utils._SeismologyBase,
salvus.flow.simple_config.source.cartesian.SideSetVectorPoint3D,
):
def __init__(
self,
latitude: float,
longitude: float,
depth_in_m: float = 0.0,
radius_of_sphere_in_m: float = 6371000.0,
fz: float,
fn: float,
fe: float,
side_set_name: str,
source_time_function: "'salvus.flow.simple_config.stf._Base | None'" = None,
rotation_on_input: "'dict | None'" = None,
reference_time_utc_string: Optional[str] = None,
): ...ARGUMENTS
Required
latitude| Type: | float |
| Description: | The latitude in degrees. |
Required
longitude| Type: | float |
| Description: | The longitude in degrees. |
Optional
depth_in_m| Type: | float |
| Default value: | 0.0 |
| Description: | The depth in meters of the receiver below the specified side set. |
Optional
radius_of_sphere_in_m| Type: | float |
| Default value: | 6371000.0 |
| Description: | Planet radius used for the initial guess of the receiver. Can be a really rough estimate. |
Required
fz| Type: | float |
| Description: | Z component of the force in N. |
Required
fn| Type: | float |
| Description: | N component of the force in N. |
Required
fe| Type: | float |
| Description: | E component of the force in N. |
Required
side_set_name| Type: | str |
| Description: | Name of the side at which to place the receiver. |
Optional
source_time_function| Type: | "'salvus.flow.simple_config.stf._Base | None'" |
| Default value: | None |
| Description: | Source time function. |
Optional
rotation_on_input| Type: | "'dict | None'" |
| Default value: | None |
| Description: | Transform the input STF according to this matrix. |
Optional
reference_time_utc_string| Type: | Optional[str] |
| Default value: | None |
| Description: | Reference time for the source. Usually equal to the origin time. If it is set, the reference time for whole simulation will be set to this time. |
VectorGradientPoint2D
Seismological 2-D vector gradient source.
SIGNATURE
class VectorGradientPoint2D(
salvus.flow.simple_config.coordinate_system_utils._SeismologyBase,
salvus.flow.simple_config.source._BaseSource,
):
def __init__(
self,
longitude: float,
depth_in_m: float = 0.0,
radius_of_sphere_in_m: float = 6371000.0,
grr: float,
grp: float,
gpr: float,
gpp: float,
source_time_function: "salvus.flow.simple_config.stf._Base | None" = None,
rotation_on_input: "dict | None" = None,
reference_time_utc_string: Optional[str] = None,
): ...ARGUMENTS
Required
longitude| Type: | float |
| Description: | The longitude in degree. |
Optional
depth_in_m| Type: | float |
| Default value: | 0.0 |
| Description: | The depth in meters of the receiver. |
Optional
radius_of_sphere_in_m| Type: | float |
| Default value: | 6371000.0 |
| Description: | This class assumes a perfect sphere to derive the cartesian coordinates of the receiver. This is the radius of that sphere. |
Required
grr| Type: | float |
| Description: | RR component of the gradient. |
Required
grp| Type: | float |
| Description: | RP component of the gradient. |
Required
gpr| Type: | float |
| Description: | PR component of the gradient. |
Required
gpp| Type: | float |
| Description: | PP component of the gradient. |
Optional
source_time_function| Type: | 'salvus.flow.simple_config.stf._Base | None' |
| Default value: | None |
| Description: | Source time function. |
Optional
rotation_on_input| Type: | 'dict | None' |
| Default value: | None |
| Description: | Transform the input STF according to this matrix. |
Optional
reference_time_utc_string| Type: | Optional[str] |
| Default value: | None |
| Description: | Reference time for the source. Usually equal to the origin time. If it is set, the reference time for whole simulation will be set to this time. |
VectorGradientPoint3D
Seismological 3-D vector gradient source.
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 VectorGradientPoint3D(
salvus.flow.simple_config.coordinate_system_utils._SeismologyBase,
salvus.flow.simple_config.source._BaseSource,
):
def __init__(
self,
latitude: float,
longitude: float,
depth_in_m: float = 0.0,
radius_of_sphere_in_m: float = 6371000.0,
grr: float,
grt: float,
grp: float,
gtr: float,
gtt: float,
gtp: float,
gpr: float,
gpt: float,
gpp: float,
source_time_function: "salvus.flow.simple_config.stf._Base | None" = None,
rotation_on_input: "dict | None" = None,
reference_time_utc_string: Optional[str] = None,
): ...ARGUMENTS
Required
latitude| Type: | float |
| Description: | The latitude in degrees. |
Required
longitude| Type: | float |
| Description: | The longitude in degrees. |
Optional
depth_in_m| Type: | float |
| Default value: | 0.0 |
| Description: | The depth in meters of the receiver. |
Optional
radius_of_sphere_in_m| Type: | float |
| Default value: | 6371000.0 |
| Description: | This class assumes a perfect sphere to derive the cartesian coordinates of the receiver. This is the radius of that sphere. |
Required
grr| Type: | float |
| Description: | RR component of the gradient. |
Required
grt| Type: | float |
| Description: | RT component of the gradient. |
Required
grp| Type: | float |
| Description: | RP component of the gradient. |
Required
gtr| Type: | float |
| Description: | TR component of the gradient. |
Required
gtt| Type: | float |
| Description: | TT component of the gradient. |
Required
gtp| Type: | float |
| Description: | TP component of the gradient. |
Required
gpr| Type: | float |
| Description: | PR component of the gradient. |
Required
gpt| Type: | float |
| Description: | PT component of the gradient. |
Required
gpp| Type: | float |
| Description: | PP component of the gradient. |
Optional
source_time_function| Type: | 'salvus.flow.simple_config.stf._Base | None' |
| Default value: | None |
| Description: | Source time function. |
Optional
rotation_on_input| Type: | 'dict | None' |
| Default value: | None |
| Description: | Transform the input STF according to this matrix. |
Optional
reference_time_utc_string| Type: | Optional[str] |
| Default value: | None |
| Description: | Reference time for the source. Usually equal to the origin time. If it is set, the reference time for whole simulation will be set to this time. |
VectorPoint2D
Seismological 2-D vector source.
SIGNATURE
class VectorPoint2D(
salvus.flow.simple_config.coordinate_system_utils._SeismologyBase,
salvus.flow.simple_config.source._BaseSource,
):
def __init__(
self,
longitude: float,
depth_in_m: float = 0.0,
radius_of_sphere_in_m: float = 6371000.0,
fr: float,
fp: float,
source_time_function: "salvus.flow.simple_config.stf._Base | None" = None,
rotation_on_input: "dict | None" = None,
reference_time_utc_string: Optional[str] = None,
): ...ARGUMENTS
Required
longitude| Type: | float |
| Description: | The longitude in degree. |
Optional
depth_in_m| Type: | float |
| Default value: | 0.0 |
| Description: | The depth in meters of the receiver. |
Optional
radius_of_sphere_in_m| Type: | float |
| Default value: | 6371000.0 |
| Description: | This class assumes a perfect sphere to derive the cartesian coordinates of the receiver. This is the radius of that sphere. |
Required
fr| Type: | float |
| Description: | R component of the force in N. |
Required
fp| Type: | float |
| Description: | P component of the force in N. |
Optional
source_time_function| Type: | 'salvus.flow.simple_config.stf._Base | None' |
| Default value: | None |
| Description: | Source time function. |
Optional
rotation_on_input| Type: | 'dict | None' |
| Default value: | None |
| Description: | Transform the input STF according to this matrix. |
Optional
reference_time_utc_string| Type: | Optional[str] |
| Default value: | None |
| Description: | Reference time for the source. Usually equal to the origin time. If it is set, the reference time for whole simulation will be set to this time. |
VectorPoint3D
Seismological 3-D vector source.
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 VectorPoint3D(
salvus.flow.simple_config.coordinate_system_utils._SeismologyBase,
salvus.flow.simple_config.source._BaseSource,
):
def __init__(
self,
latitude: float,
longitude: float,
depth_in_m: float = 0.0,
radius_of_sphere_in_m: float = 6371000.0,
fr: float,
ft: float,
fp: float,
source_time_function: "salvus.flow.simple_config.stf._Base | None" = None,
rotation_on_input: "dict | None" = None,
reference_time_utc_string: Optional[str] = None,
): ...ARGUMENTS
Required
latitude| Type: | float |
| Description: | The latitude in degrees. |
Required
longitude| Type: | float |
| Description: | The longitude in degrees. |
Optional
depth_in_m| Type: | float |
| Default value: | 0.0 |
| Description: | The depth in meters of the receiver. |
Optional
radius_of_sphere_in_m| Type: | float |
| Default value: | 6371000.0 |
| Description: | This class assumes a perfect sphere to derive the cartesian coordinates of the receiver. This is the radius of that sphere. |
Required
fr| Type: | float |
| Description: | R component of the force in N. |
Required
ft| Type: | float |
| Description: | T component of the force in N. |
Required
fp| Type: | float |
| Description: | P component of the force in N. |
Optional
source_time_function| Type: | 'salvus.flow.simple_config.stf._Base | None' |
| Default value: | None |
| Description: | Source time function. |
Optional
rotation_on_input| Type: | 'dict | None' |
| Default value: | None |
| Description: | Transform the input STF according to this matrix. |
Optional
reference_time_utc_string| Type: | Optional[str] |
| Default value: | None |
| Description: | Reference time for the source. Usually equal to the origin time. If it is set, the reference time for whole simulation will be set to this time. |
VectorPoint3DZNE
Seismological 3-D vector source.
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 VectorPoint3DZNE(
salvus.flow.simple_config.coordinate_system_utils._SeismologyBase,
salvus.flow.simple_config.source._BaseSource,
):
def __init__(
self,
latitude: float,
longitude: float,
depth_in_m: float = 0.0,
radius_of_sphere_in_m: float = 6371000.0,
fz: float,
fn: float,
fe: float,
source_time_function: "salvus.flow.simple_config.stf._Base | None" = None,
rotation_on_input: "dict | None" = None,
reference_time_utc_string: Optional[str] = None,
): ...ARGUMENTS
Required
latitude| Type: | float |
| Description: | The latitude in degrees. |
Required
longitude| Type: | float |
| Description: | The longitude in degree. |
Optional
depth_in_m| Type: | float |
| Default value: | 0.0 |
| Description: | The depth in meters of the receiver. |
Optional
radius_of_sphere_in_m| Type: | float |
| Default value: | 6371000.0 |
| Description: | This class assumes a perfect sphere to derive the cartesian coordinates of the receiver. This is the radius of that sphere. |
Required
fz| Type: | float |
| Description: | R component of the force in N. |
Required
fn| Type: | float |
| Description: | T component of the force in N. |
Required
fe| Type: | float |
| Description: | P component of the force in N. |
Optional
source_time_function| Type: | 'salvus.flow.simple_config.stf._Base | None' |
| Default value: | None |
| Description: | Source time function. |
Optional
rotation_on_input| Type: | 'dict | None' |
| Default value: | None |
| Description: | Transform the input STF according to this matrix. |
Optional
reference_time_utc_string| Type: | Optional[str] |
| Default value: | None |
| Description: | Reference time for the source. Usually equal to the origin time. If it is set, the reference time for whole simulation will be set to this time. |
Exceptions
SalvusFlowSourceParseError
Parent class:
salvus.flow.simple_config.SalvusFlowSimpleConfigExceptionRaised if a source file could not be parsed.
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