Mondaic Documentation
www.mondaic.com
Mondaic
Version:
No results found.
python_api
/
salvus
/
project
/
configuration
/
model
/
background
/
homogeneous

salvus.project.configuration.model.background.homogeneous

salvus.project.configuration.model.background.homogeneous salvus project configuration model background homogeneous
Homogeneous background models.

Classes

FromMaterial

General homogeneous background model from any material.
General homogeneous background model from any material.
SIGNATURE
class FromMaterial(
    salvus.project.configuration.model.background._BackgroundBase
):
    def __init__(self, material: Material): ...
ARGUMENTS
Required
material
Type:Material
Description:
The material.s

Class Methods

FromMaterial.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

FromMaterial.name()
Name of the model.
SIGNATURE
def name(self) -> str | typing.Callable: ...
FromMaterial.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.

IsotropicAcoustic

Base class for background models.
Isotropic acoustic background model.
SIGNATURE
class IsotropicAcoustic(
    salvus.project.configuration.model.background._BackgroundBase
):
    def __init__(self, rho: float, vp: float): ...
ARGUMENTS
Required
rho
Type:float
Description:
The density.
Required
vp
Type:float
Description:
The p-wave velocity.

Class Methods

IsotropicAcoustic.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

IsotropicAcoustic.name()
Name of the model.
SIGNATURE
def name(self) -> str | typing.Callable: ...
IsotropicAcoustic.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.

IsotropicElastic

Base class for background models.
Isotropic elastic background model.
SIGNATURE
class IsotropicElastic(
    salvus.project.configuration.model.background._BackgroundBase
):
    def __init__(self, rho: float, vp: float, vs: float): ...
ARGUMENTS
Required
rho
Type:float
Description:
The density.
Required
vp
Type:float
Description:
The p-wave velocity.
Required
vs
Type:float
Description:
The s-wave velocity.

Class Methods

IsotropicElastic.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

IsotropicElastic.name()
Name of the model.
SIGNATURE
def name(self) -> str | typing.Callable: ...
IsotropicElastic.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.

IsotropicViscoElastic

Base class for background models.
Viscoelastic isotropic background model.
SIGNATURE
class IsotropicViscoElastic(
    salvus.project.configuration.model.background._BackgroundBase
):
    def __init__(
        self, rho: float, vp: float, vs: float, qkappa: float, qmu: float
    ) -> None: ...
ARGUMENTS
Required
rho
Type:float
Description:
Density.
Required
vp
Type:float
Description:
P-wave velocity.
Required
vs
Type:float
Description:
S-wave velocity.
Required
qkappa
Type:float
Description:
Qkappa.
Required
qmu
Type:float
Description:
Qmu.

Class Methods

IsotropicViscoElastic.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

IsotropicViscoElastic.name()
Name of the model.
SIGNATURE
def name(self) -> str | typing.Callable: ...
IsotropicViscoElastic.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.
Data Analysis / Data Fusion / How to combine (fuse) measured and simulated data in Salvus
Data Analysis / Receiver Gathers / Creating and plotting custom gathers from Salvus' receiver outputs
Data Analysis / Structured Data Interface / Using the xarray structured data interface within Salvus
First Steps / My First Salvus Inversion
Getting Started / Lamb's problem / Part 1
Inversion / Homogeneous Media / Inverting for homogeneous material
Inversion / Waveform Inversion / Full-Waveform Inversion / Part 2
Meshing / Mesh2mesh Interpolation / Mesh-to-mesh interpolation
Models And Topo / 3d Surface Topography / Surface topography
Models And Topo / Simple Topography / Simple surface topography
Sources And Receivers / Equivalence Filtering Stfs And Filtering Synthetics / Equivalence of Filtering STFs and Filtering Synthetics
Sources And Receivers / Phased Arrays / Wavefield Focusing with Phased Arrays in 2D
Waveform Physics / Materials And Anisotropy / Materials 4: Simulating with Materials and Exotic Waveforms from Anisotropy
Previous
background
Next
one_dimensional
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