Version:

salvus.project.configuration.simulation_configuration

salvus.project.configuration.simulation_configuration salvus project configuration simulation_configuration
The simulation configuration.

Classes

SimulationConfiguration

Base simulation configurations.
Simulation configuration assembling everything required to turn an abstract domain into a concrete waveform simulation.
SIGNATURE
class SimulationConfiguration(
    salvus.project.configuration.simulation_configuration._SimulationConfigurationBase
):
    def __init__(
        self,
        name: str,
        elements_per_wavelength: salvus._core.types.float_,
        tensor_order: salvus._core.types.int_ = 1,
        min_period_in_seconds: salvus._core.types.float_ | None = None,
        max_frequency_in_hertz: salvus._core.types.float_ | None = None,
        max_depth_in_meters: salvus._core.types.float_ | None = None,
        model_configuration: ModelConfiguration | salvus.material.Material,
        topography_configuration: TopographyConfiguration | None = None,
        bathymetry_configuration: BathymetryConfiguration | None = None,
        absorbing_boundaries: AbsorbingBoundaryParameters | None = None,
        event_configuration: (
            EventConfiguration | dict[str, EventConfiguration]
        ),
        event_dependent_mesh_masking: str | typing.Callable | None = None,
    ) -> None: ...
ARGUMENTS
Required
name
Type:str
Description:
Name of the simulation configuration.
Required
elements_per_wavelength
Type:salvus._core.types.float_
Description:
Desired elements per wavelength.
Optional
tensor_order
Type:salvus._core.types.int_
Default value:1
Description:
The tensor order of the mesh.
Optional
min_period_in_seconds
Type:salvus._core.types.float_ | None
Default value:None
Description:
Minimum mesh period in seconds.
Optional
max_frequency_in_hertz
Type:salvus._core.types.float_ | None
Default value:None
Description:
Maximum mesh frequency in Hertz.
Optional
max_depth_in_meters
Type:salvus._core.types.float_ | None
Default value:None
Description:
Max depth in meters.
Required
model_configuration
Type:ModelConfiguration | salvus.material.Material
Description:
The model configuration or homogeneous material.
Optional
topography_configuration
Type:TopographyConfiguration | None
Default value:None
Description:
The topography configuration.
Optional
bathymetry_configuration
Type:BathymetryConfiguration | None
Default value:None
Description:
The bathymetry configuration.
Optional
absorbing_boundaries
Type:AbsorbingBoundaryParameters | None
Default value:None
Description:
The absorbing boundary configuration.
Required
event_configuration
Type:EventConfiguration | dict[str, EventConfiguration]
Description:
Event configuration.
Optional
event_dependent_mesh_masking
Type:str | typing.Callable | None
Default value:None
Description:
Optional callback function for event-dependent aperture masking of the mesh.

Properties

  • event_dependent_mesh_masking(typing.Callable | None)-Get the mesh masking function if available.
  • event_dependent_mesh_masking_str(str | None)-Get the mesh masking function as string if available.
  • min_period_in_seconds(float)-Minimum period in seconds.

Class Methods

SimulationConfiguration.from_json()
Recreate the object from a dictionary serialization of its initialization parameters.
SIGNATURE
def from_json(d: builtins.dict) -> Any: ...
ARGUMENTS
Required
d
Type:builtins.dict
Description:
Dictionary containing its init parameters and a few other things.

Methods

SimulationConfiguration.to_json()
Serialize the object to dictionary that can be written to JSON.
SIGNATURE
def to_json(self) -> dict: ...

UnstructuredMeshSimulationConfiguration

Base simulation configurations.
Directly use an unstructured mesh as a simulation configuration object.
SIGNATURE
class UnstructuredMeshSimulationConfiguration(
    salvus.project.configuration.simulation_configuration._SimulationConfigurationBase
):
    def __init__(
        self,
        name: str,
        unstructured_mesh: (
            UnstructuredMesh | ChunkedMesh | Mesh | DistributedMesh
        ),
        event_configuration: (
            EventConfiguration | dict[str, EventConfiguration] | None
        ),
        event_dependent_mesh_masking: str | typing.Callable | None = None,
    ): ...
ARGUMENTS
Required
name
Type:str
Description:
Name of the simulation configuration.
Required
unstructured_mesh
Type:UnstructuredMesh | ChunkedMesh | Mesh | DistributedMesh
Description:
Unstructured mesh object.
Required
event_configuration
Type:EventConfiguration | dict[str, EventConfiguration] | None
Description:
Event configuration.
Optional
event_dependent_mesh_masking
Type:str | typing.Callable | None
Default value:None
Description:
Optional callback function for event-dependent aperture masking of the mesh.

Properties

  • event_dependent_mesh_masking(typing.Callable | None)-Get the mesh masking function if available.
  • event_dependent_mesh_masking_str(str | None)-Get the mesh masking function as string if available.

Class Methods

UnstructuredMeshSimulationConfiguration.from_json()
Recreate the object from a dictionary serialization of its initialization parameters.
SIGNATURE
def from_json(d: builtins.dict) -> Any: ...
ARGUMENTS
Required
d
Type:builtins.dict
Description:
Dictionary containing its init parameters and a few other things.

Methods

UnstructuredMeshSimulationConfiguration.to_json()
Serialize the object to a dictionary that can be written to JSON.
SIGNATURE
def to_json(
    self,
    external_file_hash: types = None,
    timer: types = None,
    log_to_logger: bool = False,
    comm: types = None,
) -> builtins.dict: ...
ARGUMENTS
Optional
external_file_hash
Type:types
Default value:None
Description:
Hash of any external files associated with this object. Can be passed here in which case it will be stored in a centralized location in the JSON file.
Optional
timer
Type:types
Default value:None
Description:
Execution timer.
Optional
log_to_logger
Type:bool
Default value:False
Description:
Log timings to the logger.
Optional
comm
Type:types
Default value:None
Description:
MPI communicator, if any.

Used in tutorials

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