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

salvus.project.configuration.simulation_configuration

Classes

SimulationConfiguration

class SimulationConfiguration(
    salvus.project.configuration.simulation_configuration._SimulationConfigurationBase,
    salvus.flow.utils.serialization_helpers.SerializationMixin,
):
    def __init__(
        self,
        name: str,
        elements_per_wavelength: Union[
            int, numpy.int32, numpy.int64, float, numpy.float32, numpy.float64
        ],
        tensor_order: Union[int, numpy.int32, numpy.int64] = 1,
        min_period_in_seconds: Optional[
            int, numpy.int32, numpy.int64, float, numpy.float32, numpy.float64
        ] = None,
        max_frequency_in_hertz: Optional[
            int, numpy.int32, numpy.int64, float, numpy.float32, numpy.float64
        ] = None,
        max_depth_in_meters: Optional[
            int, numpy.int32, numpy.int64, float, numpy.float32, numpy.float64
        ] = None,
        model_configuration: salvus.project.configuration.model.ModelConfiguration,
        topography_configuration: Optional[
            salvus.project.configuration.topography.TopographyConfiguration
        ] = None,
        bathymetry_configuration: Optional[
            salvus.project.configuration.bathymetry.BathymetryConfiguration
        ] = None,
        absorbing_boundaries: Optional[
            salvus.mesh.simple_mesh.basic_mesh.AbsorbingBoundaryParameters
        ] = None,
        event_configuration: Union[
            salvus.project.configuration.event_configuration.EventConfiguration,
            Dict[
                str,
                salvus.project.configuration.event_configuration.EventConfiguration,
            ],
        ],
        event_dependent_mesh_masking: Optional[str, Callable] = None,
    ) -> None: ...

Simulation configuration assembling everything required to turn an abstract domain into a concrete waveform simulation.

Parameters
  • name str — Name of the simulation configuration.
  • elements_per_wavelength Union[int, numpy.int32, numpy.int64, float, numpy.float32, numpy.float64] — Desired elements per wavelength.
  • tensor_order Union[int, numpy.int32, numpy.int64] — The tensor order of the mesh.
  • min_period_in_seconds Optional[int, numpy.int32, numpy.int64, float, numpy.float32, numpy.float64] — Minimum mesh period in seconds.
  • max_frequency_in_hertz Optional[int, numpy.int32, numpy.int64, float, numpy.float32, numpy.float64] — Maximum mesh frequency in Hertz.
  • max_depth_in_meters Optional[int, numpy.int32, numpy.int64, float, numpy.float32, numpy.float64] — Max depth in meters.
  • model_configuration salvus.project.configuration.model.ModelConfiguration — The model configuration.
  • topography_configuration Optional[salvus.project.configuration.topography.TopographyConfiguration] — The topography configuration.
  • bathymetry_configuration Optional[salvus.project.configuration.bathymetry.BathymetryConfiguration] — The bathymetry configuration.
  • absorbing_boundaries Optional[salvus.mesh.simple_mesh.basic_mesh.AbsorbingBoundaryParameters] — The absorbing boundary configuration.
  • event_configuration Union[salvus.project.configuration.event_configuration.EventConfiguration, Dict[str, salvus.project.configuration.event_configuration.EventConfiguration]] — Event configuration.
  • event_dependent_mesh_masking Optional[str, Callable] — Optional callback function for event-dependent aperture masking of the mesh.
Attributes
event_dependent_mesh_masking Optional[Callable]

Get the mesh masking function if available.

event_dependent_mesh_masking_str Optional[str]

Get the mesh masking function as string if available.

min_period_in_seconds float

Minimum period in seconds.

Methods
from_json()
def from_json(d: Dict) -> Any: ...

Recreate the object from a dictionary serialization of its initialization parameters.

Parameters
  • d Dict — Dictionary containing its init parameters and a few other things.
Returns Any
to_json()
def to_json(self) -> Dict: ...

Serialize the object to dictionary that can be written to JSON.

Returns Dict

UnstructuredMeshSimulationConfiguration

class UnstructuredMeshSimulationConfiguration(
    salvus.project.configuration.simulation_configuration._SimulationConfigurationBase
):
    def __init__(
        self,
        name: str,
        unstructured_mesh: salvus.mesh.data_structures.unstructured_mesh.unstructured_mesh.UnstructuredMesh,
        event_configuration: Union[
            salvus.project.configuration.event_configuration.EventConfiguration,
            Dict[
                str,
                salvus.project.configuration.event_configuration.EventConfiguration,
            ],
        ],
        event_dependent_mesh_masking: Optional[str, Callable] = None,
    ): ...

Directly use an unstructured mesh as a simulation configuration object.

Parameters
  • name str — Name of the simulation configuration.
  • unstructured_mesh salvus.mesh.data_structures.unstructured_mesh.unstructured_mesh.UnstructuredMesh — Unstructured mesh object.
  • event_configuration Union[salvus.project.configuration.event_configuration.EventConfiguration, Dict[str, salvus.project.configuration.event_configuration.EventConfiguration]] — Event configuration.
  • event_dependent_mesh_masking Optional[str, Callable] — Optional callback function for event-dependent aperture masking of the mesh.
Attributes
event_dependent_mesh_masking Optional[Callable]

Get the mesh masking function if available.

event_dependent_mesh_masking_str Optional[str]

Get the mesh masking function as string if available.