Mondaic Documentation
www.mondaic.com
Mondaic
Version:
No results found.
python_api
/
salvus
/
material
/
utils

salvus.material.utils

salvus.material.utils salvus material utils
Utils for SalvusMaterial.

Functions

extract_tensor()

Extract the stiffness or acoustic tensor from a material.
Creates a full tensor from the material's parameters in Voigt notation as a NumPy array, even if some entries are not defined in the symmetry of the material. These are the elliptic coefficients of the wave equation solved by SalvusCompute.
The return of this function is not enough to reconstruct the material fully, as it does not include the density or M0 parameters.
SIGNATURE
def extract_tensor(
    material: PhysicalMaterial, ndim: typing.Literal[2, 3] = 3
) -> npt.NDArray: ...
ARGUMENTS
Required
material
Type:PhysicalMaterial
Description:
The material to extract the tensor from.
Optional
ndim
Type:typing.Literal[2, 3]
Default value:3
Description:
The number of dimensions.
RETURNS
Return type: npt.NDArray
The material's tensor (elliptic coefficients) in Voigt notation.

is_acoustic()

Determine if a (list of) material(s) is acoustic.
SIGNATURE
def is_acoustic(
    material: Material | type[Material] | list[Material | type[Material]],
) -> bool | list[bool]: ...
ARGUMENTS
Required
material
Type:Material | type[Material] | list[Material | type[Material]]
Description:
The material or list of materials to check.
RETURNS
Return type: bool | list[bool]
A boolean or list of booleans.

is_anisotropic()

Determine if a (list of) material(s) is anisotropic.
SIGNATURE
def is_anisotropic(
    material: Material | list[Material],
) -> bool | list[bool]: ...
ARGUMENTS
Required
material
Type:Material | list[Material]
Description:
The material or list of materials to check.
RETURNS
Return type: bool | list[bool]
A boolean or list of booleans.

is_attenuating()

Determine if a (list of) material(s) is attenuating.
SIGNATURE
def is_attenuating(
    material: Material | list[Material],
) -> bool | list[bool]: ...
ARGUMENTS
Required
material
Type:Material | list[Material]
Description:
The material or list of materials to check.
RETURNS
Return type: bool | list[bool]
A boolean or list of booleans.

is_elastic()

Determine if a (list of) material(s) is elastic.
SIGNATURE
def is_elastic(
    material: Material | type[Material] | list[Material | type[Material]],
) -> bool | list[bool]: ...
ARGUMENTS
Required
material
Type:Material | type[Material] | list[Material | type[Material]]
Description:
The material or list of materials to check.
RETURNS
Return type: bool | list[bool]
A boolean or list of booleans.

is_homogeneous()

Determine if a (list of) material(s) is homogeneous.
SIGNATURE
def is_homogeneous(
    material: Material | list[Material],
) -> bool | list[bool]: ...
ARGUMENTS
Required
material
Type:Material | list[Material]
Description:
The material or list of materials to check.
RETURNS
Return type: bool | list[bool]
A boolean or list of booleans.

is_isotropic()

Determine if a (list of) material(s) is isotropic.
SIGNATURE
def is_isotropic(material: Material | list[Material]) -> bool | list[bool]: ...
ARGUMENTS
Required
material
Type:Material | list[Material]
Description:
The material or list of materials to check.
RETURNS
Return type: bool | list[bool]
A boolean or list of booleans.

is_oriented()

Determine if a (list of) material(s) is oriented.
SIGNATURE
def is_oriented(material: Material | list[Material]) -> bool | list[bool]: ...
ARGUMENTS
Required
material
Type:Material | list[Material]
Description:
The material or list of materials to check.
RETURNS
Return type: bool | list[bool]
A boolean or list of booleans.

Submodules

compute_symbolic_jacobian
wavelength_oracle
Previous
approx_oracle_plugins
Next
compute_symbolic_jacobian
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