salvus.material.base_materials
salvus.material.base_materials salvus material base_materials Base materials.
Functions
construct_material()
construct_material()def construct_material(
cls: type[M], fields: typing.Mapping[str, typing.Any]
) -> M: ...Construct a material from a flat field-name-to-value mapping.
clstype[M] — Material class to construct.fieldstyping.Mapping[str, typing.Any] — Mapping of field names to values.
material_field_names()
material_field_names()def material_field_names(obj: Material | type[Material]) -> list[str]: ...Dataclass field names of a material, excluding extensions.
objMaterial | type[Material] — A material instance or class.
extensions.material_shallow_dict()
material_shallow_dict()def material_shallow_dict(obj: Material) -> dict: ...Shallow dict of a material’s parameter fields, excluding extensions.
objMaterial — A material instance.
extensions.Classes
GenericTensorComponents
GenericTensorComponentsclass GenericTensorComponents(salvus.material.base_materials.PhysicalMaterial):
def __init__(
self, extensions: typing.Mapping[str, Material] = default
) -> None: ...Base class for all tensor components for acoustic and elastic systems.
Sets outs required functionality and common interfaces.
extensionstyping.Mapping[str, Material] =<factory>— Attached extension materials, keyed by name. Each concrete material lists the names it accepts in_supported_extensions.
attenuation Material | None
attenuation Material | NoneOptional attenuation extension.
ds typing.Mapping
ds typing.MappingMaterial’s xarray representation.
flatten dict
flatten dictGet all parameters as a dict, including extension parameters.
orientation Material | None
orientation Material | NoneOptional orientation extension.
all_components()
all_components()def all_components() -> list[str]: ...Get all components.
equal_components()
equal_components()def equal_components() -> dict[str, str]: ...Get equal components for a material class.
from_dataset()
from_dataset()def from_dataset(ds: xr.Dataset) -> Material[_pd.types.ParameterFlavorT]: ...Construct a material from an xarray Dataset.
dsxr.Dataset — The dataset to construct the material from.
from_json()
from_json()def from_json(d: Dict) -> Any: ...Recreate the object from a dictionary serialization of its initialization parameters.
Only load trusted input.
dDict — Dictionary containing its init parameters and a few other things.
from_material()
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.
mMaterial[_pd.types.ParameterFlavorT] — Material to transform.reduction_methodtyping.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, whileremove-componentswill 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.
from_params()
from_params()def from_params() -> Self: ...Construct a material from its parameters.
See concrete materials for more information on each material’s accepted parameters
from_tensor_components()
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.
mGenericTensorComponents[_pd.types.ParameterFlavorT] — The material in tensor components parametrization to be used to construct the new material.reduction_methodtyping.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, whileremove-componentswill 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.
material_system()
material_system()def material_system() -> type[Material]: ...Method that will return the material system of material.
nonzero_components()
nonzero_components()def nonzero_components() -> list[str]: ...Get nonzero components for a material class.
zero_components()
zero_components()def zero_components() -> list[str]: ...Get zero components for a material class.
map()
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.
ftyping.Callable[[str, typing.Any], tuple[str, typing.Any]] — Callable taking (key, value) and returning (key, value).
map_realized_parameters()
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.
f_constanttyping.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_discretetyping.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_analytictyping.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.
qc_test()
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.
levelvalidation.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_issuesbool =True— If True, prints the issues found during the quality control checks. If False, issues are collected but not printed.
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()
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.
external_file_hashOptional[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.timerOptional[salvus._core.timer.timer.Timer] =None— Execution timer.log_to_loggerbool =False— Log timings to the logger.commOptional[int] =None— MPI communicator, if any.
to_tensor_components()
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.
expand_symmetriesbool =False— boolean determining if to return a expanded canonical parameters instead of the TensorComponents object in the relevant symmetry system. Defaults to False.
to_wavelength_oracle()
to_wavelength_oracle()def to_wavelength_oracle(
self, n_dim: typing.Literal[2, 3] | None = None
) -> _pd.types.ParameterOrConstantT: ...The wavelength oracle.
n_dimtyping.Literal[2, 3] | None =None— Dimension to return the oracle for, deprecated.
with_extension()
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.
namestr — Extension name (e.g.,"attenuation","orientation").valueMaterial | None — Extension material, orNoneto remove.
Material
Materialclass Material(
salvus.flow.utils.serialization_helpers.SerializationMixin,
salvus.utils.dataclass_utils.MappableDataclass,
abc.ABC,
typing.Generic,
):
def __init__(
self, extensions: typing.Mapping[str, Material] = default
) -> 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.
extensionstyping.Mapping[str, Material] =<factory>— Attached extension materials, keyed by name. Each concrete material lists the names it accepts in_supported_extensions.
attenuation Material | None
attenuation Material | NoneOptional attenuation extension.
ds typing.Mapping
ds typing.MappingMaterial’s xarray representation.
flatten dict
flatten dictGet all parameters as a dict, including extension parameters.
orientation Material | None
orientation Material | NoneOptional orientation extension.
from_dataset()
from_dataset()def from_dataset(ds: xr.Dataset) -> Material[_pd.types.ParameterFlavorT]: ...Construct a material from an xarray Dataset.
dsxr.Dataset — The dataset to construct the material from.
from_json()
from_json()def from_json(d: Dict) -> Any: ...Recreate the object from a dictionary serialization of its initialization parameters.
Only load trusted input.
dDict — Dictionary containing its init parameters and a few other things.
from_material()
from_material()def from_material(
m: Material[_pd.types.ParameterFlavorT],
reduction_method: (
typing.Literal["remove-components", "force"] | None
) = None,
) -> M: ...Construct this material from another within the same physical system.
mMaterial[_pd.types.ParameterFlavorT] — Material to transform.reduction_methodtyping.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, whileremove-componentswill 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.
from_params()
from_params()def from_params() -> Self: ...Construct a material from its parameters.
See concrete materials for more information on each material’s accepted parameters
material_system()
material_system()def material_system() -> type[Material]: ...Method that will return the material system of material.
map()
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.
ftyping.Callable[[str, typing.Any], tuple[str, typing.Any]] — Callable taking (key, value) and returning (key, value).
map_realized_parameters()
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.
f_constanttyping.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_discretetyping.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_analytictyping.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.
qc_test()
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.
levelvalidation.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_issuesbool =True— If True, prints the issues found during the quality control checks. If False, issues are collected but not printed.
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()
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.
external_file_hashOptional[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.timerOptional[salvus._core.timer.timer.Timer] =None— Execution timer.log_to_loggerbool =False— Log timings to the logger.commOptional[int] =None— MPI communicator, if any.
to_wavelength_oracle()
to_wavelength_oracle()def to_wavelength_oracle(
self, n_dim: typing.Literal[2, 3] | None = None
) -> _pd.types.ParameterOrConstantT: ...The wavelength oracle.
n_dimtyping.Literal[2, 3] | None =None— Dimension to return the oracle for, deprecated.
with_extension()
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.
namestr — Extension name (e.g.,"attenuation","orientation").valueMaterial | None — Extension material, orNoneto remove.
PhysicalMaterial
PhysicalMaterialclass PhysicalMaterial(salvus.material.base_materials.Material):
def __init__(
self, extensions: typing.Mapping[str, Material] = default
) -> None: ...All materials, excluding plugins like attenuation and orientation.
extensionstyping.Mapping[str, Material] =<factory>— Attached extension materials, keyed by name. Each concrete material lists the names it accepts in_supported_extensions.
attenuation Material | None
attenuation Material | NoneOptional attenuation extension.
ds typing.Mapping
ds typing.MappingMaterial’s xarray representation.
flatten dict
flatten dictGet all parameters as a dict, including extension parameters.
orientation Material | None
orientation Material | NoneOptional orientation extension.
from_dataset()
from_dataset()def from_dataset(ds: xr.Dataset) -> Material[_pd.types.ParameterFlavorT]: ...Construct a material from an xarray Dataset.
dsxr.Dataset — The dataset to construct the material from.
from_json()
from_json()def from_json(d: Dict) -> Any: ...Recreate the object from a dictionary serialization of its initialization parameters.
Only load trusted input.
dDict — Dictionary containing its init parameters and a few other things.
from_material()
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.
mMaterial[_pd.types.ParameterFlavorT] — Material to transform.reduction_methodtyping.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, whileremove-componentswill 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.
from_params()
from_params()def from_params() -> Self: ...Construct a material from its parameters.
See concrete materials for more information on each material’s accepted parameters
from_tensor_components()
from_tensor_components()def from_tensor_components(
m: GenericTensorComponents[_pd.types.ParameterFlavorT],
reduction_method: (
typing.Literal["remove-components", "force"] | None
) = None,
) -> PM: ...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.
mGenericTensorComponents[_pd.types.ParameterFlavorT] — The material in tensor components parametrization to be used to construct the new material.reduction_methodtyping.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, whileremove-componentswill 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.
material_system()
material_system()def material_system() -> type[Material]: ...Method that will return the material system of material.
map()
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.
ftyping.Callable[[str, typing.Any], tuple[str, typing.Any]] — Callable taking (key, value) and returning (key, value).
map_realized_parameters()
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.
f_constanttyping.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_discretetyping.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_analytictyping.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.
qc_test()
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.
levelvalidation.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_issuesbool =True— If True, prints the issues found during the quality control checks. If False, issues are collected but not printed.
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()
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.
external_file_hashOptional[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.timerOptional[salvus._core.timer.timer.Timer] =None— Execution timer.log_to_loggerbool =False— Log timings to the logger.commOptional[int] =None— MPI communicator, if any.
to_tensor_components()
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.
expand_symmetriesbool =False— boolean determining if to return a expanded canonical parameters instead of the TensorComponents object in the relevant symmetry system. Defaults to False.
to_wavelength_oracle()
to_wavelength_oracle()def to_wavelength_oracle(
self, n_dim: typing.Literal[2, 3] | None = None
) -> _pd.types.ParameterOrConstantT: ...The wavelength oracle.
n_dimtyping.Literal[2, 3] | None =None— Dimension to return the oracle for, deprecated.
with_extension()
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.
namestr — Extension name (e.g.,"attenuation","orientation").valueMaterial | None — Extension material, orNoneto remove.