Mondaic

salvus.project.configuration.model.background.homogeneous

salvus.project.configuration.model.background.homogeneous salvus project configuration model background homogeneous

Homogeneous background models.

Classes

FromMaterial

class FromMaterial(
    salvus.project.configuration.model.background._BackgroundBase
):
    def __init__(self, material: Material): ...

General homogeneous background model from any material.

General homogeneous background model from any material.

Parameters
  • material Material — The material.s
Methods
from_json()
def from_json(d: builtins.dict) -> Any: ...

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

Parameters
  • d builtins.dict — Dictionary containing its init parameters and a few other things.
Returns Any
name()
def name(self) -> str | typing.Callable: ...

Name of the model.

Returns str | typing.Callable
to_json()
def to_json(
    self,
    external_file_hash: types = None,
    timer: types = None,
    log_to_logger: bool = False,
    comm: types = None,
) -> builtins.dict: ...

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

Parameters
  • external_file_hash types — 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.
  • timer types — Execution timer.
  • log_to_logger bool — Log timings to the logger.
  • comm types — MPI communicator, if any.
Returns builtins.dict

IsotropicAcoustic

class IsotropicAcoustic(
    salvus.project.configuration.model.background._BackgroundBase
):
    def __init__(self, rho: float, vp: float): ...

Base class for background models.

Isotropic acoustic background model.

Parameters
  • rho float — The density.
  • vp float — The p-wave velocity.
Methods
from_json()
def from_json(d: builtins.dict) -> Any: ...

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

Parameters
  • d builtins.dict — Dictionary containing its init parameters and a few other things.
Returns Any
name()
def name(self) -> str | typing.Callable: ...

Name of the model.

Returns str | typing.Callable
to_json()
def to_json(
    self,
    external_file_hash: types = None,
    timer: types = None,
    log_to_logger: bool = False,
    comm: types = None,
) -> builtins.dict: ...

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

Parameters
  • external_file_hash types — 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.
  • timer types — Execution timer.
  • log_to_logger bool — Log timings to the logger.
  • comm types — MPI communicator, if any.
Returns builtins.dict

IsotropicElastic

class IsotropicElastic(
    salvus.project.configuration.model.background._BackgroundBase
):
    def __init__(self, rho: float, vp: float, vs: float): ...

Base class for background models.

Isotropic elastic background model.

Parameters
  • rho float — The density.
  • vp float — The p-wave velocity.
  • vs float — The s-wave velocity.
Methods
from_json()
def from_json(d: builtins.dict) -> Any: ...

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

Parameters
  • d builtins.dict — Dictionary containing its init parameters and a few other things.
Returns Any
name()
def name(self) -> str | typing.Callable: ...

Name of the model.

Returns str | typing.Callable
to_json()
def to_json(
    self,
    external_file_hash: types = None,
    timer: types = None,
    log_to_logger: bool = False,
    comm: types = None,
) -> builtins.dict: ...

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

Parameters
  • external_file_hash types — 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.
  • timer types — Execution timer.
  • log_to_logger bool — Log timings to the logger.
  • comm types — MPI communicator, if any.
Returns builtins.dict

IsotropicViscoElastic

class IsotropicViscoElastic(
    salvus.project.configuration.model.background._BackgroundBase
):
    def __init__(
        self, rho: float, vp: float, vs: float, qkappa: float, qmu: float
    ) -> None: ...

Base class for background models.

Viscoelastic isotropic background model.

Parameters
  • rho float — Density.
  • vp float — P-wave velocity.
  • vs float — S-wave velocity.
  • qkappa float — Qkappa.
  • qmu float — Qmu.
Methods
from_json()
def from_json(d: builtins.dict) -> Any: ...

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

Parameters
  • d builtins.dict — Dictionary containing its init parameters and a few other things.
Returns Any
name()
def name(self) -> str | typing.Callable: ...

Name of the model.

Returns str | typing.Callable
to_json()
def to_json(
    self,
    external_file_hash: types = None,
    timer: types = None,
    log_to_logger: bool = False,
    comm: types = None,
) -> builtins.dict: ...

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

Parameters
  • external_file_hash types — 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.
  • timer types — Execution timer.
  • log_to_logger bool — Log timings to the logger.
  • comm types — MPI communicator, if any.
Returns builtins.dict

Used in tutorials