Skip to content

salvus.material.acoustic.elliptical_hexagonal

salvus.material.acoustic.elliptical_hexagonal salvus material acoustic elliptical_hexagonal

Hexagonal (VTI) anisotropic acoustic materials.

Classes

TensorComponents

class TensorComponents(
    salvus.material.acoustic.elliptical_hexagonal._EllipticalHexagonal,
    salvus.material.acoustic.AcousticTensorComponents,
):
    def __init__(
        self,
        M0: _pd.types.ParameterOrConstantT,
        D11: _pd.types.ParameterOrConstantT,
        D33: _pd.types.ParameterOrConstantT,
        extensions: typing.Mapping[str, Material] = default,
    ) -> None: ...

Elliptical hexagonal anisotropic acoustic material parametrized by acoustic tensor.

Parameters
  • M0 _pd.types.ParameterOrConstantT — The density in kg / m^3.
  • D11 _pd.types.ParameterOrConstantT — The d_11 component of the acoustic tensor.
  • D33 _pd.types.ParameterOrConstantT — The d_33 component of the acoustic tensor.
  • extensions typing.Mapping[str, Material] = <factory> — Attached extension materials. Supported: attenuation, orientation.
Attributes
attenuation Material | None

Optional attenuation extension.

ds typing.Mapping

Material’s xarray representation.

flatten dict

Get all parameters as a dict, including extension parameters.

orientation Material | None

Optional orientation extension.

Methods
all_components()
def all_components() -> list[str]: ...

Get all components.

Returns list[str]
equal_components()
def equal_components() -> dict[str, str]: ...

Get equal components for a material class.

Returns dict[str, str]
from_dataset()
def from_dataset(ds: xr.Dataset) -> Material[_pd.types.ParameterFlavorT]: ...

Construct a material from an xarray Dataset.

Parameters
  • ds xr.Dataset — The dataset to construct the material from.
Returns Material[_pd.types.ParameterFlavorT]
from_json()
def from_json(d: Dict) -> Any: ...

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

Only load trusted input.

Parameters
  • d Dict — Dictionary containing its init parameters and a few other things.
Returns Any
from_material()
def from_material(
    m: Material[_pd.types.ParameterFlavorT],
    reduction_method: (
        typing.Literal["remove-components", "force"] | None
    ) = None,
) -> Self: ...

Construct this material from another within the same physical system.

Parameters
  • m Material[_pd.types.ParameterFlavorT] — Material to transform.
  • reduction_method typing.Literal['remove-components', 'force'] | None = None — Method to move between incompatible symmetry classes. None will only move to symmetries that are equal or more permissive, while remove-components will drop components that are found to match the new material’s constraints as necessary, and thus leading to loss of free parameters but not of information. The option “force” will take all information necessary to construct the new parameter set without verification, leading to loss of information.
Returns Self — The transformed material.
from_params()
def from_params(
    m0: _pd.types.ParameterInput,
    d11: _pd.types.ParameterInput,
    d33: _pd.types.ParameterInput,
) -> typing.Self: ...

Construct a hexagonal material from acoustic constants.

Parameters
  • m0 _pd.types.ParameterInput — The density in kg / m^3.
  • d11 _pd.types.ParameterInput — The d_11 component of the acoustic tensor.
  • d33 _pd.types.ParameterInput — The d_12 component of the acoustic tensor.
Returns typing.Self
from_tensor_components()
def from_tensor_components(
    m: GenericTensorComponents[_pd.types.ParameterFlavorT],
    reduction_method: (
        typing.Literal["remove-components", "force"] | None
    ) = None,
) -> Self: ...

Create material from tensor components acoustic parameter material.

Overwrite this method if your material can not be constructed from acoustic constants.

A class method to create a anisotropic material of a desired symmetry class from a canonical TC material. The method will automatically check if the canonical material that is passed meets the symmetry requirements of the desired materials. If it does not, a TypeError will be raised.

Parameters
  • m GenericTensorComponents[_pd.types.ParameterFlavorT] — The material in tensor components parametrization to be used to construct the new material.
  • reduction_method typing.Literal['remove-components', 'force'] | None = None — Method to move between incompatible symmetry classes. None will only move to symmetries that are equal or more permissive, while remove-components will drop components that are found to match the new material’s constraints as necessary, and thus leading to loss of free parameters but not of information. The option “force” will take all information necessary to construct the new parameter set without verification, leading to loss of information.
Returns Self
material_system()
def material_system() -> type[PhysicalMaterial]: ...

Get the material system of the material.

Returns type[PhysicalMaterial]
nonzero_components()
def nonzero_components() -> list[str]: ...

Get nonzero components for a material class.

Returns list[str]
zero_components()
def zero_components() -> list[str]: ...

Get zero components for a material class.

Returns list[str]
map()
def map(
    self, f: typing.Callable[[str, typing.Any], tuple[str, typing.Any]]
) -> Self: ...

Generic map for materials, recursing into extension materials.

See dataclass_utils.MappableDataclass.map for the base semantics. Extension materials (in extensions) are mapped independently, since f is defined in terms of a single material’s own parameter names.

Parameters
  • f typing.Callable[[str, typing.Any], tuple[str, typing.Any]] — Callable taking (key, value) and returning (key, value).
Returns Self
map_realized_parameters()
def map_realized_parameters(
    self,
    f_constant: typing.Callable[
        [str, _pd.realized.constant.Parameter], _pd.realized.constant.Parameter
    ] = salvus.material.base_materials._map_realized_default,
    f_discrete: typing.Callable[
        [str, _pd.realized.discrete.Parameter], _pd.realized.discrete.Parameter
    ] = salvus.material.base_materials._map_realized_default,
    f_analytic: typing.Callable[
        [str, _pd.realized.analytic.Parameter], _pd.realized.analytic.Parameter
    ] = salvus.material.base_materials._map_realized_default,
) -> Self: ...

Apply functions to each parameter individually, distinguishing _pd.

Useful when one wants to transform each parameter type separately. For instance, transformations of discrete parameters often require more associated logic than their constant equivalents. This function abstracts away the boilerplate of check for each parameter type, and subsequently transforming it with some function, as well as ensuring that the parameters are indeed of the correct realized type.

The signatures of each transformation function should take the parameter’s name and value as two distinct inputs, and return the (potentially modified) parameter value.

Parameters
  • f_constant typing.Callable[[str, _pd.realized.constant.Parameter], _pd.realized.constant.Parameter] = salvus.material.base_materials._map_realized_default — The function to apply to constant parameters. Defaults to returning the parameter as-is.
  • f_discrete typing.Callable[[str, _pd.realized.discrete.Parameter], _pd.realized.discrete.Parameter] = salvus.material.base_materials._map_realized_default — The function to apply to discrete parameters. Defaults to returning the parameter as-is.
  • f_analytic typing.Callable[[str, _pd.realized.analytic.Parameter], _pd.realized.analytic.Parameter] = salvus.material.base_materials._map_realized_default — The function to apply to analytic parameters. Defaults to returning the parameter as-is.
Returns Self
qc_test()
def qc_test(
    self,
    level: validation.QCLevel | str = QCLevel.strict,
    display_issues: bool = True,
) -> dict[str, MaterialQCIssue]: ...

Run a series of material quality control tests.

The function also prints a summary of the issues found, including their severity and any mitigation steps that can be taken.

Parameters
  • level validation.QCLevel | str = QCLevel.strict — The level of quality control to perform. The BASIC level performs minimal checks, while the STRICT level performs more thorough checks that are potentially slow. One can pass an enumeration value or a string representation of the level.
  • display_issues bool = True — If True, prints the issues found during the quality control checks. If False, issues are collected but not printed.
Returns dict[str, MaterialQCIssue] — A dictionary of MaterialQCIssue objects representing the issues found during the quality control checks. The keys are formatted as “type:code”, where type is the type of the issue (e.g, “mesh” or “material”) and code is a specific code for the issue (e.g., “NON_POSITIVE_VP”). If no issues are found, an empty dictionary is returned.
to_json()
def to_json(
    self,
    external_file_hash: Optional[str] = None,
    timer: Optional[salvus._core.timer.timer.Timer] = None,
    log_to_logger: bool = False,
    comm: Optional[int] = None,
) -> Dict: ...

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

Parameters
  • external_file_hash Optional[str] = None — 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 Optional[salvus._core.timer.timer.Timer] = None — Execution timer.
  • log_to_logger bool = False — Log timings to the logger.
  • comm Optional[int] = None — MPI communicator, if any.
Returns Dict
to_tensor_components()
def to_tensor_components(
    self, expand_symmetries: bool = False
) -> MaterialDict | GenericTensorComponents: ...

Generate a tensor component representation of the material.

This method ensures compatibility with solver and other symmetries.

Parameters
  • expand_symmetries bool = False — boolean determining if to return a expanded canonical parameters instead of the TensorComponents object in the relevant symmetry system. Defaults to False.
Returns MaterialDict | GenericTensorComponents — The material in tensor component form.
to_wavelength_oracle()
def to_wavelength_oracle(
    self, n_dim: typing.Literal[2, 3] | None = None
) -> _pd.types.ParameterOrConstantT: ...

The wavelength oracle.

Parameters
  • n_dim typing.Literal[2, 3] | None = None — Dimension to return the oracle for, deprecated.
Returns _pd.types.ParameterOrConstantT
with_attenuation()
def with_attenuation(self, attenuation: Material | None) -> Self: ...

Add attenuation to an object.

Parameters
  • attenuation Material | None — The attenuation material.
Returns Self — The object with an attenuation material attached.
with_extension()
def with_extension(self, name: str, value: Material | None) -> Self: ...

Attach or detach an extension material by name.

Passing value=None always removes the extension, even if name isn’t in _supported_extensions (mirrors removing something that was never there). Attaching a real value that isn’t supported raises, as does constructing the material with it directly.

Parameters
  • name str — Extension name (e.g., "attenuation", "orientation").
  • value Material | None — Extension material, or None to remove.
Returns Self
with_orientation()
def with_orientation(self, orientation: Material | None) -> Self: ...

Add orientation to a material.

Parameters
  • orientation Material | None — The orientation.
Returns Self — The object with an orientation material attached.

Velocity

class Velocity(
    salvus.material.acoustic.elliptical_hexagonal._EllipticalHexagonal
):
    def __init__(
        self,
        RHO: _pd.types.ParameterOrConstantT,
        VPV: _pd.types.ParameterOrConstantT,
        VPH: _pd.types.ParameterOrConstantT,
        extensions: typing.Mapping[str, Material] = default,
    ) -> None: ...

Elliptical hexagonal anisotropic elastic material parametrized by velocities.

Parameters
  • RHO _pd.types.ParameterOrConstantT — Density in kg / m^3.
  • VPV _pd.types.ParameterOrConstantT — Vertical P-wave velocity in m / s.
  • VPH _pd.types.ParameterOrConstantT — Horizontal P-wave velocity in m / s.
  • extensions typing.Mapping[str, Material] = <factory> — Attached extension materials. Supported: attenuation, orientation.
Attributes
attenuation Material | None

Optional attenuation extension.

ds typing.Mapping

Material’s xarray representation.

flatten dict

Get all parameters as a dict, including extension parameters.

orientation Material | None

Optional orientation extension.

Methods
from_dataset()
def from_dataset(ds: xr.Dataset) -> Material[_pd.types.ParameterFlavorT]: ...

Construct a material from an xarray Dataset.

Parameters
  • ds xr.Dataset — The dataset to construct the material from.
Returns Material[_pd.types.ParameterFlavorT]
from_json()
def from_json(d: Dict) -> Any: ...

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

Only load trusted input.

Parameters
  • d Dict — Dictionary containing its init parameters and a few other things.
Returns Any
from_material()
def from_material(
    m: Material[_pd.types.ParameterFlavorT],
    reduction_method: (
        typing.Literal["remove-components", "force"] | None
    ) = None,
) -> Self: ...

Construct this material from another within the same physical system.

Parameters
  • m Material[_pd.types.ParameterFlavorT] — Material to transform.
  • reduction_method typing.Literal['remove-components', 'force'] | None = None — Method to move between incompatible symmetry classes. None will only move to symmetries that are equal or more permissive, while remove-components will drop components that are found to match the new material’s constraints as necessary, and thus leading to loss of free parameters but not of information. The option “force” will take all information necessary to construct the new parameter set without verification, leading to loss of information.
Returns Self — The transformed material.
from_params()
def from_params(
    rho: _pd.types.ParameterInput,
    vpv: _pd.types.ParameterInput,
    vph: _pd.types.ParameterInput,
) -> typing.Self: ...

Construct this material from generic parameters.

Parameters
  • rho _pd.types.ParameterInput — Density in kg / m^3.
  • vpv _pd.types.ParameterInput — Vertical P-wave velocity in m / s.
  • vph _pd.types.ParameterInput — Horizontal P-wave velocity in m / s.
Returns typing.Self — The material.
from_tensor_components()
def from_tensor_components(
    m: GenericTensorComponents[_pd.types.ParameterFlavorT],
    reduction_method: (
        typing.Literal["remove-components", "force"] | None
    ) = None,
) -> typing.Self: ...

Create material from tensor components acoustic parameter material.

Overwrite this method if your material can not be constructed from acoustic constants.

A class method to create a anisotropic material of a desired symmetry class from a canonical TC material. The method will automatically check if the canonical material that is passed meets the symmetry requirements of the desired materials. If it does not, a TypeError will be raised.

Parameters
  • m GenericTensorComponents[_pd.types.ParameterFlavorT] — The material in tensor components parametrization to be used to construct the new material.
  • reduction_method typing.Literal['remove-components', 'force'] | None = None — Method to move between incompatible symmetry classes. None will only move to symmetries that are equal or more permissive, while remove-components will drop components that are found to match the new material’s constraints as necessary, and thus leading to loss of free parameters but not of information. The option “force” will take all information necessary to construct the new parameter set without verification, leading to loss of information.
Returns typing.Self
material_system()
def material_system() -> type[PhysicalMaterial]: ...

Get the material system of the material.

Returns type[PhysicalMaterial]
map()
def map(
    self, f: typing.Callable[[str, typing.Any], tuple[str, typing.Any]]
) -> Self: ...

Generic map for materials, recursing into extension materials.

See dataclass_utils.MappableDataclass.map for the base semantics. Extension materials (in extensions) are mapped independently, since f is defined in terms of a single material’s own parameter names.

Parameters
  • f typing.Callable[[str, typing.Any], tuple[str, typing.Any]] — Callable taking (key, value) and returning (key, value).
Returns Self
map_realized_parameters()
def map_realized_parameters(
    self,
    f_constant: typing.Callable[
        [str, _pd.realized.constant.Parameter], _pd.realized.constant.Parameter
    ] = salvus.material.base_materials._map_realized_default,
    f_discrete: typing.Callable[
        [str, _pd.realized.discrete.Parameter], _pd.realized.discrete.Parameter
    ] = salvus.material.base_materials._map_realized_default,
    f_analytic: typing.Callable[
        [str, _pd.realized.analytic.Parameter], _pd.realized.analytic.Parameter
    ] = salvus.material.base_materials._map_realized_default,
) -> Self: ...

Apply functions to each parameter individually, distinguishing _pd.

Useful when one wants to transform each parameter type separately. For instance, transformations of discrete parameters often require more associated logic than their constant equivalents. This function abstracts away the boilerplate of check for each parameter type, and subsequently transforming it with some function, as well as ensuring that the parameters are indeed of the correct realized type.

The signatures of each transformation function should take the parameter’s name and value as two distinct inputs, and return the (potentially modified) parameter value.

Parameters
  • f_constant typing.Callable[[str, _pd.realized.constant.Parameter], _pd.realized.constant.Parameter] = salvus.material.base_materials._map_realized_default — The function to apply to constant parameters. Defaults to returning the parameter as-is.
  • f_discrete typing.Callable[[str, _pd.realized.discrete.Parameter], _pd.realized.discrete.Parameter] = salvus.material.base_materials._map_realized_default — The function to apply to discrete parameters. Defaults to returning the parameter as-is.
  • f_analytic typing.Callable[[str, _pd.realized.analytic.Parameter], _pd.realized.analytic.Parameter] = salvus.material.base_materials._map_realized_default — The function to apply to analytic parameters. Defaults to returning the parameter as-is.
Returns Self
qc_test()
def qc_test(
    self,
    level: validation.QCLevel | str = QCLevel.strict,
    display_issues: bool = True,
) -> dict[str, MaterialQCIssue]: ...

Run a series of material quality control tests.

The function also prints a summary of the issues found, including their severity and any mitigation steps that can be taken.

Parameters
  • level validation.QCLevel | str = QCLevel.strict — The level of quality control to perform. The BASIC level performs minimal checks, while the STRICT level performs more thorough checks that are potentially slow. One can pass an enumeration value or a string representation of the level.
  • display_issues bool = True — If True, prints the issues found during the quality control checks. If False, issues are collected but not printed.
Returns dict[str, MaterialQCIssue] — A dictionary of MaterialQCIssue objects representing the issues found during the quality control checks. The keys are formatted as “type:code”, where type is the type of the issue (e.g, “mesh” or “material”) and code is a specific code for the issue (e.g., “NON_POSITIVE_VP”). If no issues are found, an empty dictionary is returned.
to_json()
def to_json(
    self,
    external_file_hash: Optional[str] = None,
    timer: Optional[salvus._core.timer.timer.Timer] = None,
    log_to_logger: bool = False,
    comm: Optional[int] = None,
) -> Dict: ...

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

Parameters
  • external_file_hash Optional[str] = None — 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 Optional[salvus._core.timer.timer.Timer] = None — Execution timer.
  • log_to_logger bool = False — Log timings to the logger.
  • comm Optional[int] = None — MPI communicator, if any.
Returns Dict
to_tensor_components()
def to_tensor_components(
    self, expand_symmetries: bool = False
) -> MaterialDict | GenericTensorComponents: ...

Generate a tensor component representation of the material.

This method ensures compatibility with solver and other symmetries.

Parameters
  • expand_symmetries bool = False — boolean determining if to return a expanded canonical parameters instead of the TensorComponents object in the relevant symmetry system. Defaults to False.
Returns MaterialDict | GenericTensorComponents — The material in tensor component form.
to_wavelength_oracle()
def to_wavelength_oracle(
    self, n_dim: typing.Literal[2, 3] | None = None
) -> _pd.types.ParameterOrConstantT: ...

The wavelength oracle.

Parameters
  • n_dim typing.Literal[2, 3] | None = None — Dimension to return the oracle for, deprecated.
Returns _pd.types.ParameterOrConstantT
with_attenuation()
def with_attenuation(self, attenuation: Material | None) -> Self: ...

Add attenuation to an object.

Parameters
  • attenuation Material | None — The attenuation material.
Returns Self — The object with an attenuation material attached.
with_extension()
def with_extension(self, name: str, value: Material | None) -> Self: ...

Attach or detach an extension material by name.

Passing value=None always removes the extension, even if name isn’t in _supported_extensions (mirrors removing something that was never there). Attaching a real value that isn’t supported raises, as does constructing the material with it directly.

Parameters
  • name str — Extension name (e.g., "attenuation", "orientation").
  • value Material | None — Extension material, or None to remove.
Returns Self
with_orientation()
def with_orientation(self, orientation: Material | None) -> Self: ...

Add orientation to a material.

Parameters
  • orientation Material | None — The orientation.
Returns Self — The object with an orientation material attached.

Used in tutorials