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

salvus.material.base_materials

Base materials

Classes

AllowsAttenuation

class AllowsAttenuation(
    salvus.utils.dataclass_utils.DataclassInstance, typing.Protocol
):
    def __init__(self):
        ...
Attributes
viscosity types

Get the optional attenuation.

GenericTensorComponents

class GenericTensorComponents(salvus.material.base_materials.PhysicalMaterial):
    def __init__(self) -> None: ...

Base class for all tensor components for acoustic and elastic systems.

Sets outs required functionality and common interfaces.

Attributes
ds Mapping

Material’s xarray representation.

flatten builtins.dict

Get all parameters as a dict.

Material

class Material(
    salvus.flow.utils.serialization_helpers.SerializationMixin,
    salvus.utils.dataclass_utils.MappableDataclass,
    abc.ABC,
    typing.Generic,
):
    def __init__(self) -> None: ...

Generic material interface.

Type Args: F: The field type of encapsulated variable parameters. Adds a layer of type safety when accidentally mixing certain parameter _pd.

Attributes
ds Mapping

Material’s xarray representation.

flatten builtins.dict

Get all parameters as a dict.

PhysicalMaterial

class PhysicalMaterial(salvus.material.base_materials.Material):
    def __init__(self) -> None: ...

All materials, excluding visco

Attributes
ds Mapping

Material’s xarray representation.

flatten builtins.dict

Get all parameters as a dict.