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

salvus.project.configuration.model.background.one_dimensional

salvus.project.configuration.model.background.one_dimensional salvus project configuration model background one_dimensional
One dimensional background models.

Classes

BuiltIn

Base class for background models.
Use a built-in model as the background model.
SIGNATURE
class BuiltIn(salvus.project.configuration.model.background._BackgroundBase):
    def __init__(self, name: str): ...
ARGUMENTS
Required
name
Type:str
Description:
The name of the model.

Class Methods

BuiltIn.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.
BuiltIn.prem_iso_one_crust()
A modified, isotropic version of PREM.
Upper crustal layer replaced by lower crustal material.
SIGNATURE
def prem_iso_one_crust() -> BuiltIn: ...

Methods

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

FromBm

Base class for background models.
Background model from a BM file.
SIGNATURE
class FromBm(salvus.project.configuration.model.background._BackgroundBase):
    def __init__(
        self, filename: Path | str, reference_datum: float | None = 0.0
    ): ...
ARGUMENTS
Required
filename
Type:Path | str
Description:
BM file.
Optional
reference_datum
Type:float | None
Default value:0.0
Description:
Absolute coordinate value in the vertical direction (y in 2-D, z in 3-D) to which the depth is referenced. Model values at coordinates above will be extrapolated using a constant value.

Class Methods

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

FromBm.name()
Name of the model.
SIGNATURE
def name(self) -> str | typing.Callable: ...
FromBm.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.
Previous
homogeneous
Next
utils
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