Version:

salvus.flow.simple_config.source.cartesian.collections

salvus.flow.simple_config.source.cartesian.collections salvus flow simple_config source cartesian collections
Cartesian source collections.

Classes

MomentTensorPoint2DRing

All the operations on a read-only sequence.
Concrete subclasses must override new or init, getitem, and len.
Create a ring of MomentTensorPoint2D sources.
SIGNATURE
class MomentTensorPoint2DRing(
    salvus.flow.simple_config.source.cartesian.collections._RingBase
):
    def __init__(
        self,
        x: float,
        y: float,
        radius: float,
        count: int,
        mxx: float,
        myy: float,
        mxy: float,
        source_time_function: (
            salvus.flow.simple_config.stf._Base | None
        ) = None,
    ): ...
ARGUMENTS
Required
x
Type:float
Description:
x-coordinate of the center.
Required
y
Type:float
Description:
y-coordinate of the center.
Required
radius
Type:float
Description:
Radius of the ring.
Required
count
Type:int
Description:
Number or receivers to create.
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.

ScalarGradientPoint2DRing

All the operations on a read-only sequence.
Concrete subclasses must override new or init, getitem, and len.
Create a ring of ScalarGradientPoint2D sources.
SIGNATURE
class ScalarGradientPoint2DRing(
    salvus.flow.simple_config.source.cartesian.collections._RingBase
):
    def __init__(
        self,
        x: float,
        y: float,
        radius: float,
        count: int,
        fx: float,
        fy: float,
        source_time_function: (
            salvus.flow.simple_config.stf._Base | None
        ) = None,
    ): ...
ARGUMENTS
Required
x
Type:float
Description:
x-coordinate of the center.
Required
y
Type:float
Description:
y-coordinate of the center.
Required
radius
Type:float
Description:
Radius of the ring.
Required
count
Type:int
Description:
Number or receivers to create.
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.

ScalarPoint2DRing

All the operations on a read-only sequence.
Concrete subclasses must override new or init, getitem, and len.
Create a ring of ScalarPoint2D sources.
SIGNATURE
class ScalarPoint2DRing(
    salvus.flow.simple_config.source.cartesian.collections._RingBase
):
    def __init__(
        self,
        x: float,
        y: float,
        radius: float,
        count: int,
        f: float,
        source_time_function: (
            salvus.flow.simple_config.stf._Base | None
        ) = None,
    ): ...
ARGUMENTS
Required
x
Type:float
Description:
x-coordinate of the center.
Required
y
Type:float
Description:
y-coordinate of the center.
Required
radius
Type:float
Description:
Radius of the ring.
Required
count
Type:int
Description:
Number or receivers to create.
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.

VectorPoint2DRing

All the operations on a read-only sequence.
Concrete subclasses must override new or init, getitem, and len.
Create a ring of VectorPoint2D sources.
SIGNATURE
class VectorPoint2DRing(
    salvus.flow.simple_config.source.cartesian.collections._RingBase
):
    def __init__(
        self,
        x: float,
        y: float,
        radius: float,
        count: int,
        fx: float,
        fy: float,
        source_time_function: (
            salvus.flow.simple_config.stf._Base | None
        ) = None,
    ): ...
ARGUMENTS
Required
x
Type:float
Description:
x-coordinate of the center.
Required
y
Type:float
Description:
y-coordinate of the center.
Required
radius
Type:float
Description:
Radius of the ring.
Required
count
Type:int
Description:
Number or receivers to create.
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.

Used in tutorials

Functionality from this module is used in the following tutorials.
PAGE CONTENTS