This API reference is not for the latest stable Salvus version.

`salvus.flow.simple_config.source.cartesian`

Sources in a cartesian reference system.

Functions

`parse()`

def parse(dict_sources: list[dict] | dict) -> list[_Base]: ...

Parse a dictionary or a list of dictionaries to receiver objects.

Parameters

dict_sources list[dict] | dict — Parse a list of sources (or just a single source) as a dictionary to the proper objects.

Returns list[_Base]

Classes

`MomentTensorPoint2D`

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,
    ): ...

Moment tensor source in a 2-D domain.

Parameters

x float — X coordinate of the source in meter.
y float — Y coordinate of the source in meter.
mxx float — XX component of the moment in Nm.
myy float — YY component of the moment in Nm.
mxy float — XY component of the moment in Nm.
source_time_function salvus.flow.simple_config.stf._Base | None — Source time function.
rotation_on_input dict | None — Transform the input STF with this matrix.

`MomentTensorPoint3D`

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,
    ): ...

Moment tensor source in a 3-D domain.

Parameters

x float — X coordinate of the source in meter.
y float — Y coordinate of the source in meter.
z float — Z coordinate of the source in meter.
mxx float — XX component of the moment in Nm.
myy float — YY component of the moment in Nm.
mzz float — ZZ component of the moment in Nm.
myz float — YZ component of the moment in Nm.
mxz float — XZ component of the moment in Nm.
mxy float — XY component of the moment in Nm.
source_time_function salvus.flow.simple_config.stf._Base | None — Source time function.
rotation_on_input dict | None — Transform the input STF with this matrix.

`ScalarGradientPoint2D`

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,
    ): ...

Source to be injected into the gradient of the scalar displacement potential in 2D.

Parameters

x float — X coordinate of the source in meter.
y float — Y coordinate of the source in meter.
fx float — Source amplitude scaling factor of X component.
fy float — Source amplitude scaling factor of Y component.
source_time_function salvus.flow.simple_config.stf._Base | None — Source time function.
rotation_on_input dict | None — Transform the input STF with this matrix.

`ScalarGradientPoint3D`

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,
    ): ...

Source to be injected into the gradient of the scalar displacement potential in 3D.

Parameters

x float — X coordinate of the source in meter.
y float — Y coordinate of the source in meter.
z float — Z coordinate of the source in meter.
fx float — Source amplitude scaling factor of X component.
fy float — Source amplitude scaling factor of Y component.
fz float — Source amplitude scaling factor of Z component.
source_time_function salvus.flow.simple_config.stf._Base | None — Source time function.
rotation_on_input dict | None — Transform the input STF with this matrix.

`ScalarPoint2D`

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,
    ): ...

Scalar source in a 2-D domain.

Parameters

x float — X coordinate of the source in meter.
y float — Y coordinate of the source in meter.
f float — Source amplitude scaling factor.
source_time_function salvus.flow.simple_config.stf._Base | None — Source time function.

`ScalarPoint3D`

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,
    ): ...

Scalar source in a 3-D domain.

Parameters

x float — X coordinate of the source in meter.
y float — Y coordinate of the source in meter.
z float — Z coordinate of the source in meter.
f float — Source amplitude scaling factor.
source_time_function salvus.flow.simple_config.stf._Base | None — Source time function.

`SideSetMomentTensorPoint2D`

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,
    ): ...

Moment tensor side-set source in a 2-D domain.

Parameters

point np.ndarray — Reference point for the side set receiver placement.
direction Union[np.ndarray, str] — Direction vector for the side set receiver placement.
offset float — Offset in the direction vector in meter.
side_set_name str — Name of the side set to intersect.
mxx 'float' — XX component of the moment in Nm.
myy 'float' — YY component of the moment in Nm.
mxy 'float' — XY component of the moment in Nm.
source_time_function 'salvus.flow.simple_config.stf._Base | None' — Source time function.
rotation_on_input 'dict | None' — Transform the input STF according to this matrix.

`SideSetMomentTensorPoint3D`

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,
    ): ...

Moment tensor side-set source in a 3-D domain.

Parameters

point np.ndarray — Reference point for the side set receiver placement.
direction Union[np.ndarray, str] — Direction vector for the side set receiver placement.
offset float — Offset in the direction vector in meter.
side_set_name str — Name of the side set to intersect.
mxx 'float' — XX component of the moment in Nm.
myy 'float' — YY component of the moment in Nm.
mzz 'float' — ZZ component of the moment in Nm.
myz 'float' — YZ component of the moment in Nm.
mxz 'float' — XZ component of the moment in Nm.
mxy 'float' — XY component of the moment in Nm.
source_time_function 'salvus.flow.simple_config.stf._Base | None' — Source time function.
rotation_on_input 'dict | None' — Transform the input STF according to this matrix.

`SideSetScalarGradientPoint2D`

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,
    ): ...

Source to be injected into the gradient of the scalar displacement potential in 2D.

Parameters

point np.ndarray — Reference point for the side set receiver placement.
direction Union[np.ndarray, str] — Direction vector for the side set receiver placement.
offset float — Offset in the direction vector in meter.
side_set_name str — Name of the side set to intersect.
fx 'float' — Source amplitude scaling factor of X component.
fy 'float' — Source amplitude scaling factor of Y component.
source_time_function 'salvus.flow.simple_config.stf._Base | None' — Source time function.
rotation_on_input 'dict | None' — Transform the input STF according to this matrix.

`SideSetScalarGradientPoint3D`

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,
    ): ...

Source to be injected into the gradient of the scalar displacement potential in 3D.

Parameters

point np.ndarray — Reference point for the side set receiver placement.
direction Union[np.ndarray, str] — Direction vector for the side set receiver placement.
offset float — Offset in the direction vector in meter.
side_set_name str — Name of the side set to intersect.
fx 'float' — Source amplitude scaling factor of X component.
fy 'float' — Source amplitude scaling factor of Y component.
fz 'float' — Source amplitude scaling factor of Z component.
source_time_function 'salvus.flow.simple_config.stf._Base | None' — Source time function.
rotation_on_input 'dict | None' — Transform the input STF according to this matrix.

`SideSetScalarPoint2D`

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,
    ): ...

Scalar side-set source in a 2-D domain.

Parameters

point np.ndarray — Reference point for the side set receiver placement.
direction Union[np.ndarray, str] — Direction vector for the side set receiver placement.
offset float — Offset in the direction vector in meter.
side_set_name str — Name of the side set to intersect.
f 'float' — Source amplitude scaling factor.
source_time_function 'salvus.flow.simple_config.stf._Base | None' — Source time function.

`SideSetScalarPoint3D`

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,
    ): ...

Scalar side-set source in a 3-D domain.

Parameters

point np.ndarray — Reference point for the side set receiver placement.
direction Union[np.ndarray, str] — Direction vector for the side set receiver placement.
offset float — Offset in the direction vector in meter.
side_set_name str — Name of the side set to intersect.
f 'float' — Source amplitude scaling factor.
source_time_function 'salvus.flow.simple_config.stf._Base | None' — Source time function.

`SideSetVectorGradientPoint2D`

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,
    ): ...

Vector gradient side-set source in a 2-D domain.

Parameters

point np.ndarray — Reference point for the side set receiver placement.
direction Union[np.ndarray, str] — Direction vector for the side set receiver placement.
offset float — Offset in the direction vector in meter.
side_set_name str — Name of the side set to intersect.
gxx 'float' — XX component of the gradient in Nm.
gxy 'float' — XY component of the gradient in Nm.
gyx 'float' — YX component of the gradient in Nm.
gyy 'float' — YY component of the gradient in Nm.
source_time_function 'salvus.flow.simple_config.stf._Base | None' — Source time function.
rotation_on_input 'dict | None' — Transform the input STF according to this matrix.

`SideSetVectorGradientPoint3D`

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,
    ): ...

Vector gradient side-set source in a 3-D domain.

Parameters

point np.ndarray — Reference point for the side set receiver placement.
direction Union[np.ndarray, str] — Direction vector for the side set receiver placement.
offset float — Offset in the direction vector in meter.
side_set_name str — Name of the side set to intersect.
gxx 'float' — XX component of the gradient in Nm.
gxy 'float' — XY component of the gradient in Nm.
gxz 'float' — XZ component of the gradient in Nm.
gyx 'float' — YX component of the gradient in Nm.
gyy 'float' — YY component of the gradient in Nm.
gyz 'float' — YZ component of the gradient in Nm.
gzx 'float' — ZX component of the gradient in Nm.
gzy 'float' — ZY component of the gradient in Nm.
gzz 'float' — ZZ component of the gradient in Nm.
source_time_function 'salvus.flow.simple_config.stf._Base | None' — Source time function.
rotation_on_input 'dict | None' — Transform the input STF according to this matrix.

`SideSetVectorPoint2D`

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,
    ): ...

Vector side-set source in a 2-D domain.

Parameters

point np.ndarray — Reference point for the side set receiver placement.
direction Union[np.ndarray, str] — Direction vector for the side set receiver placement.
offset float — Offset in the direction vector in meter.
side_set_name str — Name of the side set to intersect.
fx 'float' — X component of the force in N.
fy 'float' — Y component of the force in N.
source_time_function 'salvus.flow.simple_config.stf._Base | None' — Source time function.
rotation_on_input 'dict | None' — Transform the input STF according to this matrix.

`SideSetVectorPoint3D`

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,
    ): ...

Vector side-set source in a 3-D domain.

Parameters

point np.ndarray — Reference point for the side set receiver placement.
direction Union[np.ndarray, str] — Direction vector for the side set receiver placement.
offset float — Offset in the direction vector in meter.
side_set_name str — Name of the side set to intersect.
fx 'float' — X component of the force in N.
fy 'float' — Y component of the force in N.
fz 'float' — Z component of the force in N.
source_time_function 'salvus.flow.simple_config.stf._Base | None' — Source time function.
rotation_on_input 'dict | None' — Transform the input STF according to this matrix.

`VectorGradientPoint2D`

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,
    ): ...

Vector gradient source in a 2-D domain.

Parameters

x float — X coordinate of the source in meter.
y float — Y coordinate of the source in meter.
gxx float — XX component of the gradient in Nm.
gxy float — XY component of the gradient in Nm.
gyx float — YX component of the gradient in Nm.
gyy float — YY component of the gradient in Nm.
source_time_function salvus.flow.simple_config.stf._Base | None — Source time function.
rotation_on_input dict | None — Transform the input STF with this matrix.

`VectorGradientPoint3D`

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,
    ): ...

Vector gradient source in a 3-D domain.

Parameters

x float — X coordinate of the source in meter.
y float — Y coordinate of the source in meter.
z float — Z coordinate of the source in meter.
gxx float — XX component of the gradient in Nm.
gxy float — XY component of the gradient in Nm.
gxz float — XZ component of the gradient in Nm.
gyx float — YX component of the gradient in Nm.
gyy float — YY component of the gradient in Nm.
gyz float — YZ component of the gradient in Nm.
gzx float — ZX component of the gradient in Nm.
gzy float — ZY component of the gradient in Nm.
gzz float — ZZ component of the gradient in Nm.
source_time_function salvus.flow.simple_config.stf._Base | None — Source time function.
rotation_on_input dict | None — Transform the input STF with this matrix.

`VectorPoint2D`

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,
    ): ...

Vector source in a 2-D domain.

Parameters

x float — X coordinate of the source in meter.
y float — Y coordinate of the source in meter.
fx float — X component of the force in N.
fy float — Y component of the force in N.
source_time_function salvus.flow.simple_config.stf._Base | None — Source time function.
rotation_on_input dict | None — Transform the input STF with this matrix.

`VectorPoint3D`

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,
    ): ...

Vector source in a 3-D domain.

Parameters

x float — X coordinate of the source in meter.
y float — Y coordinate of the source in meter.
z float — Z coordinate of the source in meter.
fx float — X component of the force in N.
fy float — Y component of the force in N.
fz float — Z component of the force in N.
source_time_function salvus.flow.simple_config.stf._Base | None — Source time function.
rotation_on_input dict | None — Transform the input STF with this matrix.

Submodules

salvus.flow.simple_config.source.cartesian.collections