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

salvus.flow.simple_config.source.cartesian

salvus.flow.simple_config.source.cartesian salvus flow simple_config source cartesian
Sources in a cartesian reference system.

Functions

parse()

Parse a dictionary or a list of dictionaries to receiver objects.
SIGNATURE
def parse(dict_sources: list[dict] | dict) -> list[_Base]: ...
ARGUMENTS
Required
dict_sources
Type:list[dict] | dict
Description:
Parse a list of sources (or just a single source) as a dictionary to the proper objects.
RETURNS
Return type: list[_Base]

Classes

MomentTensorPoint2D

Moment tensor source in a 2-D domain.
SIGNATURE
class MomentTensorPoint2D(salvus.flow.simple_config.source._BaseSource):
    def __init__(
        self,
        x: float,
        y: float,
        mxx: float,
        myy: float,
        mxy: float,
        source_time_function: (
            salvus.flow.simple_config.stf._Base | None
        ) = None,
        rotation_on_input: dict | None = None,
    ): ...
ARGUMENTS
Required
x
Type:float
Description:
X coordinate of the source in meter.
Required
y
Type:float
Description:
Y coordinate of the source in meter.
Required
mxx
Type:float
Description:
XX component of the moment in Nm.
Required
myy
Type:float
Description:
YY component of the moment in Nm.
Required
mxy
Type:float
Description:
XY 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 with this matrix.

MomentTensorPoint3D

Moment tensor source in a 3-D domain.
SIGNATURE
class MomentTensorPoint3D(salvus.flow.simple_config.source._BaseSource):
    def __init__(
        self,
        x: float,
        y: float,
        z: float,
        mxx: float,
        myy: float,
        mzz: float,
        myz: float,
        mxz: float,
        mxy: float,
        source_time_function: (
            salvus.flow.simple_config.stf._Base | None
        ) = None,
        rotation_on_input: dict | None = None,
    ): ...
ARGUMENTS
Required
x
Type:float
Description:
X coordinate of the source in meter.
Required
y
Type:float
Description:
Y coordinate of the source in meter.
Required
z
Type:float
Description:
Z coordinate of the source in meter.
Required
mxx
Type:float
Description:
XX component of the moment in Nm.
Required
myy
Type:float
Description:
YY component of the moment in Nm.
Required
mzz
Type:float
Description:
ZZ component of the moment in Nm.
Required
myz
Type:float
Description:
YZ component of the moment in Nm.
Required
mxz
Type:float
Description:
XZ component of the moment in Nm.
Required
mxy
Type:float
Description:
XY 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 with this matrix.

ScalarGradientPoint2D

Source to be injected into the gradient of the scalar displacement potential in 2D.
SIGNATURE
class ScalarGradientPoint2D(salvus.flow.simple_config.source._BaseSource):
    def __init__(
        self,
        x: float,
        y: float,
        fx: float,
        fy: float,
        source_time_function: (
            salvus.flow.simple_config.stf._Base | None
        ) = None,
        rotation_on_input: dict | None = None,
    ): ...
ARGUMENTS
Required
x
Type:float
Description:
X coordinate of the source in meter.
Required
y
Type:float
Description:
Y coordinate of the source in meter.
Required
fx
Type:float
Description:
Source amplitude scaling factor of X component.
Required
fy
Type:float
Description:
Source amplitude scaling factor of Y 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 with this matrix.

ScalarGradientPoint3D

Source to be injected into the gradient of the scalar displacement potential in 3D.
SIGNATURE
class ScalarGradientPoint3D(salvus.flow.simple_config.source._BaseSource):
    def __init__(
        self,
        x: float,
        y: float,
        z: float,
        fx: float,
        fy: float,
        fz: float,
        source_time_function: (
            salvus.flow.simple_config.stf._Base | None
        ) = None,
        rotation_on_input: dict | None = None,
    ): ...
ARGUMENTS
Required
x
Type:float
Description:
X coordinate of the source in meter.
Required
y
Type:float
Description:
Y coordinate of the source in meter.
Required
z
Type:float
Description:
Z coordinate of the source in meter.
Required
fx
Type:float
Description:
Source amplitude scaling factor of X component.
Required
fy
Type:float
Description:
Source amplitude scaling factor of Y component.
Required
fz
Type:float
Description:
Source amplitude scaling factor of Z 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 with this matrix.

ScalarPoint2D

Scalar source in a 2-D domain.
SIGNATURE
class ScalarPoint2D(salvus.flow.simple_config.source._BaseSource):
    def __init__(
        self,
        x: float,
        y: float,
        f: float,
        source_time_function: (
            salvus.flow.simple_config.stf._Base | None
        ) = None,
    ): ...
ARGUMENTS
Required
x
Type:float
Description:
X coordinate of the source in meter.
Required
y
Type:float
Description:
Y coordinate of the source in meter.
Required
f
Type:float
Description:
Source amplitude scaling factor.
Optional
source_time_function
Type:salvus.flow.simple_config.stf._Base | None
Default value:None
Description:
Source time function.

ScalarPoint3D

Scalar source in a 3-D domain.
SIGNATURE
class ScalarPoint3D(salvus.flow.simple_config.source._BaseSource):
    def __init__(
        self,
        x: float,
        y: float,
        z: float,
        f: float,
        source_time_function: (
            salvus.flow.simple_config.stf._Base | None
        ) = None,
    ): ...
ARGUMENTS
Required
x
Type:float
Description:
X coordinate of the source in meter.
Required
y
Type:float
Description:
Y coordinate of the source in meter.
Required
z
Type:float
Description:
Z coordinate of the source in meter.
Required
f
Type:float
Description:
Source amplitude scaling factor.
Optional
source_time_function
Type:salvus.flow.simple_config.stf._Base | None
Default value:None
Description:
Source time function.

SideSetMomentTensorPoint2D

Moment tensor side-set source in a 2-D domain.
SIGNATURE
class SideSetMomentTensorPoint2D(
    salvus.flow.simple_config.side_set_base._SideSetBase,
    salvus.flow.simple_config.source._SideSetSource,
):
    def __init__(
        self,
        point: np.ndarray,
        direction: Union[np.ndarray, str],
        offset: float = 0.0,
        side_set_name: str,
        mxx: "float",
        myy: "float",
        mxy: "float",
        source_time_function: "salvus.flow.simple_config.stf._Base | None" = None,
        rotation_on_input: "dict | None" = None,
    ): ...
ARGUMENTS
Required
point
Type:np.ndarray
Description:
Reference point for the side set receiver placement.
Required
direction
Type:Union[np.ndarray, str]
Description:
Direction vector for the side set receiver placement.
Optional
offset
Type:float
Default value:0.0
Description:
Offset in the direction vector in meter.
Required
side_set_name
Type:str
Description:
Name of the side set to intersect.
Required
mxx
Type:'float'
Description:
XX component of the moment in Nm.
Required
myy
Type:'float'
Description:
YY component of the moment in Nm.
Required
mxy
Type:'float'
Description:
XY 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.

SideSetMomentTensorPoint3D

Moment tensor side-set source in a 3-D domain.
SIGNATURE
class SideSetMomentTensorPoint3D(
    salvus.flow.simple_config.side_set_base._SideSetBase,
    salvus.flow.simple_config.source._SideSetSource,
):
    def __init__(
        self,
        point: np.ndarray,
        direction: Union[np.ndarray, str],
        offset: float = 0.0,
        side_set_name: str,
        mxx: "float",
        myy: "float",
        mzz: "float",
        myz: "float",
        mxz: "float",
        mxy: "float",
        source_time_function: "salvus.flow.simple_config.stf._Base | None" = None,
        rotation_on_input: "dict | None" = None,
    ): ...
ARGUMENTS
Required
point
Type:np.ndarray
Description:
Reference point for the side set receiver placement.
Required
direction
Type:Union[np.ndarray, str]
Description:
Direction vector for the side set receiver placement.
Optional
offset
Type:float
Default value:0.0
Description:
Offset in the direction vector in meter.
Required
side_set_name
Type:str
Description:
Name of the side set to intersect.
Required
mxx
Type:'float'
Description:
XX component of the moment in Nm.
Required
myy
Type:'float'
Description:
YY component of the moment in Nm.
Required
mzz
Type:'float'
Description:
ZZ component of the moment in Nm.
Required
myz
Type:'float'
Description:
YZ component of the moment in Nm.
Required
mxz
Type:'float'
Description:
XZ component of the moment in Nm.
Required
mxy
Type:'float'
Description:
XY 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.

SideSetScalarGradientPoint2D

Source to be injected into the gradient of the scalar displacement potential in 2D.
SIGNATURE
class SideSetScalarGradientPoint2D(
    salvus.flow.simple_config.side_set_base._SideSetBase,
    salvus.flow.simple_config.source._SideSetSource,
):
    def __init__(
        self,
        point: np.ndarray,
        direction: Union[np.ndarray, str],
        offset: float = 0.0,
        side_set_name: str,
        fx: "float",
        fy: "float",
        source_time_function: "salvus.flow.simple_config.stf._Base | None" = None,
        rotation_on_input: "dict | None" = None,
    ): ...
ARGUMENTS
Required
point
Type:np.ndarray
Description:
Reference point for the side set receiver placement.
Required
direction
Type:Union[np.ndarray, str]
Description:
Direction vector for the side set receiver placement.
Optional
offset
Type:float
Default value:0.0
Description:
Offset in the direction vector in meter.
Required
side_set_name
Type:str
Description:
Name of the side set to intersect.
Required
fx
Type:'float'
Description:
Source amplitude scaling factor of X component.
Required
fy
Type:'float'
Description:
Source amplitude scaling factor of Y 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.

SideSetScalarGradientPoint3D

Source to be injected into the gradient of the scalar displacement potential in 3D.
SIGNATURE
class SideSetScalarGradientPoint3D(
    salvus.flow.simple_config.side_set_base._SideSetBase,
    salvus.flow.simple_config.source._SideSetSource,
):
    def __init__(
        self,
        point: np.ndarray,
        direction: Union[np.ndarray, str],
        offset: float = 0.0,
        side_set_name: str,
        fx: "float",
        fy: "float",
        fz: "float",
        source_time_function: "salvus.flow.simple_config.stf._Base | None" = None,
        rotation_on_input: "dict | None" = None,
    ): ...
ARGUMENTS
Required
point
Type:np.ndarray
Description:
Reference point for the side set receiver placement.
Required
direction
Type:Union[np.ndarray, str]
Description:
Direction vector for the side set receiver placement.
Optional
offset
Type:float
Default value:0.0
Description:
Offset in the direction vector in meter.
Required
side_set_name
Type:str
Description:
Name of the side set to intersect.
Required
fx
Type:'float'
Description:
Source amplitude scaling factor of X component.
Required
fy
Type:'float'
Description:
Source amplitude scaling factor of Y component.
Required
fz
Type:'float'
Description:
Source amplitude scaling factor of Z 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.

SideSetScalarPoint2D

Scalar side-set source in a 2-D domain.
SIGNATURE
class SideSetScalarPoint2D(
    salvus.flow.simple_config.side_set_base._SideSetBase,
    salvus.flow.simple_config.source._SideSetSource,
):
    def __init__(
        self,
        point: np.ndarray,
        direction: Union[np.ndarray, str],
        offset: float = 0.0,
        side_set_name: str,
        f: "float",
        source_time_function: "salvus.flow.simple_config.stf._Base | None" = None,
    ): ...
ARGUMENTS
Required
point
Type:np.ndarray
Description:
Reference point for the side set receiver placement.
Required
direction
Type:Union[np.ndarray, str]
Description:
Direction vector for the side set receiver placement.
Optional
offset
Type:float
Default value:0.0
Description:
Offset in the direction vector in meter.
Required
side_set_name
Type:str
Description:
Name of the side set to intersect.
Required
f
Type:'float'
Description:
Source amplitude scaling factor.
Optional
source_time_function
Type:'salvus.flow.simple_config.stf._Base | None'
Default value:None
Description:
Source time function.

SideSetScalarPoint3D

Scalar side-set source in a 3-D domain.
SIGNATURE
class SideSetScalarPoint3D(
    salvus.flow.simple_config.side_set_base._SideSetBase,
    salvus.flow.simple_config.source._SideSetSource,
):
    def __init__(
        self,
        point: np.ndarray,
        direction: Union[np.ndarray, str],
        offset: float = 0.0,
        side_set_name: str,
        f: "float",
        source_time_function: "salvus.flow.simple_config.stf._Base | None" = None,
    ): ...
ARGUMENTS
Required
point
Type:np.ndarray
Description:
Reference point for the side set receiver placement.
Required
direction
Type:Union[np.ndarray, str]
Description:
Direction vector for the side set receiver placement.
Optional
offset
Type:float
Default value:0.0
Description:
Offset in the direction vector in meter.
Required
side_set_name
Type:str
Description:
Name of the side set to intersect.
Required
f
Type:'float'
Description:
Source amplitude scaling factor.
Optional
source_time_function
Type:'salvus.flow.simple_config.stf._Base | None'
Default value:None
Description:
Source time function.

SideSetVectorGradientPoint2D

Vector gradient side-set source in a 2-D domain.
SIGNATURE
class SideSetVectorGradientPoint2D(
    salvus.flow.simple_config.side_set_base._SideSetBase,
    salvus.flow.simple_config.source._SideSetSource,
):
    def __init__(
        self,
        point: np.ndarray,
        direction: Union[np.ndarray, str],
        offset: float = 0.0,
        side_set_name: str,
        gxx: "float",
        gxy: "float",
        gyx: "float",
        gyy: "float",
        source_time_function: "salvus.flow.simple_config.stf._Base | None" = None,
        rotation_on_input: "dict | None" = None,
    ): ...
ARGUMENTS
Required
point
Type:np.ndarray
Description:
Reference point for the side set receiver placement.
Required
direction
Type:Union[np.ndarray, str]
Description:
Direction vector for the side set receiver placement.
Optional
offset
Type:float
Default value:0.0
Description:
Offset in the direction vector in meter.
Required
side_set_name
Type:str
Description:
Name of the side set to intersect.
Required
gxx
Type:'float'
Description:
XX component of the gradient in Nm.
Required
gxy
Type:'float'
Description:
XY component of the gradient in Nm.
Required
gyx
Type:'float'
Description:
YX component of the gradient in Nm.
Required
gyy
Type:'float'
Description:
YY component of the gradient 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.

SideSetVectorGradientPoint3D

Vector gradient side-set source in a 3-D domain.
SIGNATURE
class SideSetVectorGradientPoint3D(
    salvus.flow.simple_config.side_set_base._SideSetBase,
    salvus.flow.simple_config.source._SideSetSource,
):
    def __init__(
        self,
        point: np.ndarray,
        direction: Union[np.ndarray, str],
        offset: float = 0.0,
        side_set_name: str,
        gxx: "float",
        gxy: "float",
        gxz: "float",
        gyx: "float",
        gyy: "float",
        gyz: "float",
        gzx: "float",
        gzy: "float",
        gzz: "float",
        source_time_function: "salvus.flow.simple_config.stf._Base | None" = None,
        rotation_on_input: "dict | None" = None,
    ): ...
ARGUMENTS
Required
point
Type:np.ndarray
Description:
Reference point for the side set receiver placement.
Required
direction
Type:Union[np.ndarray, str]
Description:
Direction vector for the side set receiver placement.
Optional
offset
Type:float
Default value:0.0
Description:
Offset in the direction vector in meter.
Required
side_set_name
Type:str
Description:
Name of the side set to intersect.
Required
gxx
Type:'float'
Description:
XX component of the gradient in Nm.
Required
gxy
Type:'float'
Description:
XY component of the gradient in Nm.
Required
gxz
Type:'float'
Description:
XZ component of the gradient in Nm.
Required
gyx
Type:'float'
Description:
YX component of the gradient in Nm.
Required
gyy
Type:'float'
Description:
YY component of the gradient in Nm.
Required
gyz
Type:'float'
Description:
YZ component of the gradient in Nm.
Required
gzx
Type:'float'
Description:
ZX component of the gradient in Nm.
Required
gzy
Type:'float'
Description:
ZY component of the gradient in Nm.
Required
gzz
Type:'float'
Description:
ZZ component of the gradient 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.

SideSetVectorPoint2D

Vector side-set source in a 2-D domain.
SIGNATURE
class SideSetVectorPoint2D(
    salvus.flow.simple_config.side_set_base._SideSetBase,
    salvus.flow.simple_config.source._SideSetSource,
):
    def __init__(
        self,
        point: np.ndarray,
        direction: Union[np.ndarray, str],
        offset: float = 0.0,
        side_set_name: str,
        fx: "float",
        fy: "float",
        source_time_function: "salvus.flow.simple_config.stf._Base | None" = None,
        rotation_on_input: "dict | None" = None,
    ): ...
ARGUMENTS
Required
point
Type:np.ndarray
Description:
Reference point for the side set receiver placement.
Required
direction
Type:Union[np.ndarray, str]
Description:
Direction vector for the side set receiver placement.
Optional
offset
Type:float
Default value:0.0
Description:
Offset in the direction vector in meter.
Required
side_set_name
Type:str
Description:
Name of the side set to intersect.
Required
fx
Type:'float'
Description:
X component of the force in N.
Required
fy
Type:'float'
Description:
Y 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.

SideSetVectorPoint3D

Vector side-set source in a 3-D domain.
SIGNATURE
class SideSetVectorPoint3D(
    salvus.flow.simple_config.side_set_base._SideSetBase,
    salvus.flow.simple_config.source._SideSetSource,
):
    def __init__(
        self,
        point: np.ndarray,
        direction: Union[np.ndarray, str],
        offset: float = 0.0,
        side_set_name: str,
        fx: "float",
        fy: "float",
        fz: "float",
        source_time_function: "salvus.flow.simple_config.stf._Base | None" = None,
        rotation_on_input: "dict | None" = None,
    ): ...
ARGUMENTS
Required
point
Type:np.ndarray
Description:
Reference point for the side set receiver placement.
Required
direction
Type:Union[np.ndarray, str]
Description:
Direction vector for the side set receiver placement.
Optional
offset
Type:float
Default value:0.0
Description:
Offset in the direction vector in meter.
Required
side_set_name
Type:str
Description:
Name of the side set to intersect.
Required
fx
Type:'float'
Description:
X component of the force in N.
Required
fy
Type:'float'
Description:
Y component of the force in N.
Required
fz
Type:'float'
Description:
Z 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.

VectorGradientPoint2D

Vector gradient source in a 2-D domain.
SIGNATURE
class VectorGradientPoint2D(salvus.flow.simple_config.source._BaseSource):
    def __init__(
        self,
        x: float,
        y: float,
        gxx: float,
        gxy: float,
        gyx: float,
        gyy: float,
        source_time_function: (
            salvus.flow.simple_config.stf._Base | None
        ) = None,
        rotation_on_input: dict | None = None,
    ): ...
ARGUMENTS
Required
x
Type:float
Description:
X coordinate of the source in meter.
Required
y
Type:float
Description:
Y coordinate of the source in meter.
Required
gxx
Type:float
Description:
XX component of the gradient in Nm.
Required
gxy
Type:float
Description:
XY component of the gradient in Nm.
Required
gyx
Type:float
Description:
YX component of the gradient in Nm.
Required
gyy
Type:float
Description:
YY component of the gradient 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 with this matrix.

VectorGradientPoint3D

Vector gradient source in a 3-D domain.
SIGNATURE
class VectorGradientPoint3D(salvus.flow.simple_config.source._BaseSource):
    def __init__(
        self,
        x: float,
        y: float,
        z: float,
        gxx: float,
        gxy: float,
        gxz: float,
        gyx: float,
        gyy: float,
        gyz: float,
        gzx: float,
        gzy: float,
        gzz: float,
        source_time_function: (
            salvus.flow.simple_config.stf._Base | None
        ) = None,
        rotation_on_input: dict | None = None,
    ): ...
ARGUMENTS
Required
x
Type:float
Description:
X coordinate of the source in meter.
Required
y
Type:float
Description:
Y coordinate of the source in meter.
Required
z
Type:float
Description:
Z coordinate of the source in meter.
Required
gxx
Type:float
Description:
XX component of the gradient in Nm.
Required
gxy
Type:float
Description:
XY component of the gradient in Nm.
Required
gxz
Type:float
Description:
XZ component of the gradient in Nm.
Required
gyx
Type:float
Description:
YX component of the gradient in Nm.
Required
gyy
Type:float
Description:
YY component of the gradient in Nm.
Required
gyz
Type:float
Description:
YZ component of the gradient in Nm.
Required
gzx
Type:float
Description:
ZX component of the gradient in Nm.
Required
gzy
Type:float
Description:
ZY component of the gradient in Nm.
Required
gzz
Type:float
Description:
ZZ component of the gradient 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 with this matrix.

VectorPoint2D

Vector source in a 2-D domain.
SIGNATURE
class VectorPoint2D(salvus.flow.simple_config.source._BaseSource):
    def __init__(
        self,
        x: float,
        y: float,
        fx: float,
        fy: float,
        source_time_function: (
            salvus.flow.simple_config.stf._Base | None
        ) = None,
        rotation_on_input: dict | None = None,
    ): ...
ARGUMENTS
Required
x
Type:float
Description:
X coordinate of the source in meter.
Required
y
Type:float
Description:
Y coordinate of the source in meter.
Required
fx
Type:float
Description:
X component of the force in N.
Required
fy
Type:float
Description:
Y 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 with this matrix.

VectorPoint3D

Vector source in a 3-D domain.
SIGNATURE
class VectorPoint3D(salvus.flow.simple_config.source._BaseSource):
    def __init__(
        self,
        x: float,
        y: float,
        z: float,
        fx: float,
        fy: float,
        fz: float,
        source_time_function: (
            salvus.flow.simple_config.stf._Base | None
        ) = None,
        rotation_on_input: dict | None = None,
    ): ...
ARGUMENTS
Required
x
Type:float
Description:
X coordinate of the source in meter.
Required
y
Type:float
Description:
Y coordinate of the source in meter.
Required
z
Type:float
Description:
Z coordinate of the source in meter.
Required
fx
Type:float
Description:
X component of the force in N.
Required
fy
Type:float
Description:
Y component of the force in N.
Required
fz
Type:float
Description:
Z 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 with this matrix.

Submodules

collections

Used in tutorials

Functionality from this module is used in the following tutorials.
Advanced Interface / Lambs Problem / Lamb's Problem
Advanced Interface / Salvus Flow Api / Introduction to SalvusFlow's API
Data Analysis / Selective Volume Output / Volume output in a selected region
Examples / Integration Tests / Analytic Tests / Wave Equation / Semi-analytic Test - Acoustic
Examples / Integration Tests / Gradient Tests / Gradient Test Single Physics
Examples / Integration Tests / Gradient Tests / Gradient Test TTI Media
Getting Started / Lamb's problem / Part 1
Inversion / Homogeneous Media / Inverting for homogeneous material
Models And Topo / Parameterizations / Model Parameterizations in Salvus
Models And Topo / Simple Topography / Simple surface topography
Sources And Receivers / Custom Stf / Custom Source Time Functions
Sources And Receivers / Equivalence Filtering Stfs And Filtering Synthetics / Equivalence of Filtering STFs and Filtering Synthetics
Sources And Receivers / Introduction / Point Sources and Receivers for the Wave Equation
Sources And Receivers / Side Set Sources And Receivers / Side-set Sources and Receivers for the Wave Equation
Waveform Physics / Ocean Loading / Ocean Loading
Previous
source
Next
collections
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