Mondaic Documentation
www.mondaic.com
Mondaic
Version:
No results found.
python_api
/
salvus
/
project
/
meshing

salvus.project.meshing

salvus.project.meshing salvus project meshing
Meshing functionality for SalvusProject.

Functions

mesh_cartesian_ocean_lm()

Mesh 2- or 3-D cartesian domain with oceans using the layered mesher.
SIGNATURE
def mesh_cartesian_ocean_lm(
    domain: _domain.Domain,
    background_model: model.background._BackgroundBase,
    min_vertical_coordinate: float,
    max_vertical_coordinate: float,
    mesh_configuration: MeshConfiguration,
    topography_configuration: (
        topography._TopographyConfigurationInternal | None
    ),
    bathymetry_configuration: (
        bathymetry._BathymetryConfigurationInternal | None
    ),
    bm_shift: float = 0.0,
    interlayer_coarsening_policy: InterlayerCoarseningPolicy | None = None,
    execution_policy: bindings.ExecutionPolicy = salvus._core.lib.salvus_core_python_bindings.ExecutionPolicy,
) -> UnstructuredMesh: ...
ARGUMENTS
Required
domain
Type:_domain.Domain
Description:
The domain.
Required
background_model
Type:model.background._BackgroundBase
Description:
The background model.
Required
min_vertical_coordinate
Type:float
Description:
The minimum vertical coordinate in the mesh.
Required
max_vertical_coordinate
Type:float
Description:
The maximum vertical coordinate in the mesh.
Required
mesh_configuration
Type:MeshConfiguration
Description:
The mesh configuration.
Required
topography_configuration
Type:topography._TopographyConfigurationInternal | None
Description:
The topography configuration.
Required
bathymetry_configuration
Type:bathymetry._BathymetryConfigurationInternal | None
Description:
The bathymetry configuration.
Optional
bm_shift
Type:float
Default value:0.0
Description:
For UTM domains -- shift away from the reference datum.
Optional
interlayer_coarsening_policy
Type:InterlayerCoarseningPolicy | None
Default value:None
Description:
An optional interlayer coarsening policy that allows for overriding the default InterlayerDoubling policy. Can be useful for challenging meshes with thin layers.
Optional
execution_policy
Type:bindings.ExecutionPolicy
Default value:<salvus._core.lib.salvus_core_python_bindings.ExecutionPolicy object at 0x7c0325eb3df0>
Description:
Execution policy governing the maximum allowable parallelism of child routines.
RETURNS
Return type: UnstructuredMesh
A cartesian mesh with oceans.

mesh_from_circular_domain()

Build a mesh from a 2-D circular domain.
SIGNATURE
def mesh_from_circular_domain(
    domain: _domain.dim2.CircularDomain,
    topography: topography._TopographyConfigurationInternal | None,
    bathymetry: bathymetry._BathymetryConfigurationInternal | None,
    mesh_parameters: MeshConfiguration,
    model: model._ModelConfigurationInternal,
    verbosity: int = 1,
    execution_policy: bindings.ExecutionPolicy = salvus._core.lib.salvus_core_python_bindings.ExecutionPolicy,
) -> UnstructuredMesh: ...
ARGUMENTS
Required
domain
Type:_domain.dim2.CircularDomain
Description:
Domain.
Required
topography
Type:topography._TopographyConfigurationInternal | None
Description:
Topography configuration.
Required
bathymetry
Type:bathymetry._BathymetryConfigurationInternal | None
Description:
Bathymetry configuration.
Required
mesh_parameters
Type:MeshConfiguration
Description:
The mesh parameters.
Required
model
Type:model._ModelConfigurationInternal
Description:
The model configuration.
Optional
verbosity
Type:int
Default value:1
Description:
Verbosity level.
Optional
execution_policy
Type:bindings.ExecutionPolicy
Default value:<salvus._core.lib.salvus_core_python_bindings.ExecutionPolicy object at 0x7c0325d5c1f0>
Description:
Execution policy governing the maximum allowable parallelism of child routines.
RETURNS
Return type: UnstructuredMesh

mesh_from_domain()

Create a concrete unstructured mesh from a few pieces of information.
This function is the central entry point to generate meshes from whatever information is defined in the project. An important design aspect of this function is that it must be unit testable.
SIGNATURE
def mesh_from_domain(
    domain: _domain.Domain,
    mesh_configuration: MeshConfiguration,
    model_configuration: model._ModelConfigurationInternal,
    topography_configuration: (
        topography._TopographyConfigurationInternal | None
    ) = None,
    bathymetry_configuration: (
        bathymetry._BathymetryConfigurationInternal | None
    ) = None,
    verbosity: int = 1,
    interlayer_coarsening_policy: InterlayerCoarseningPolicy | None = None,
    execution_policy: bindings.ExecutionPolicy = salvus._core.lib.salvus_core_python_bindings.ExecutionPolicy,
    skip_validation: bool = True,
) -> UnstructuredMesh: ...
ARGUMENTS
Required
domain
Type:_domain.Domain
Description:
The domain of interest.
Required
mesh_configuration
Type:MeshConfiguration
Description:
All model independent mesh parameters.
Required
model_configuration
Type:model._ModelConfigurationInternal
Description:
A set of background and volume models.
Optional
topography_configuration
Type:topography._TopographyConfigurationInternal | None
Default value:None
Description:
A list of topography models.
Optional
bathymetry_configuration
Type:bathymetry._BathymetryConfigurationInternal | None
Default value:None
Description:
A list of bathymetry models.
Optional
verbosity
Type:int
Default value:1
Description:
Verbosity level of the operation.
Optional
interlayer_coarsening_policy
Type:InterlayerCoarseningPolicy | None
Default value:None
Description:
An optional interlayer coarsening policy that allows for overriding the default InterlayerDoubling policy. Can be useful for challenging meshes with thin layers. Currently only considered for meshes with bathymetry in cartesian domains.
Optional
execution_policy
Type:bindings.ExecutionPolicy
Default value:<salvus._core.lib.salvus_core_python_bindings.ExecutionPolicy object at 0x7c0325d5c230>
Description:
Execution policy governing the maximum allowable parallelism of child routines.
Optional
skip_validation
Type:bool
Default value:True
Description:
Skip the mesh validation step.
RETURNS
Return type: UnstructuredMesh

mesh_from_spherical_polygon()

Build a mesh from a spherical polygon.
SIGNATURE
def mesh_from_spherical_polygon(
    domain: _domain.dim3.SphericalDomain,
    topography: topography._TopographyConfigurationInternal | None,
    bathymetry: bathymetry._BathymetryConfigurationInternal | None,
    mesh_parameters: MeshConfiguration,
    spherical_polygon: SphericalPolygon | None,
    model: model._ModelConfigurationInternal,
    verbosity: int = 1,
) -> UnstructuredMesh: ...
ARGUMENTS
Required
domain
Type:_domain.dim3.SphericalDomain
Description:
Domain.
Required
topography
Type:topography._TopographyConfigurationInternal | None
Description:
Topography configuration.
Required
bathymetry
Type:bathymetry._BathymetryConfigurationInternal | None
Description:
Bathymetry configuration.
Required
mesh_parameters
Type:MeshConfiguration
Description:
The mesh parameters.
Required
spherical_polygon
Type:SphericalPolygon | None
Description:
The spherical polygon to use.
Required
model
Type:model._ModelConfigurationInternal
Description:
The model configuration.
Optional
verbosity
Type:int
Default value:1
Description:
Verbosity level.
RETURNS
Return type: UnstructuredMesh

simple_mesh_selector()

Helper function to construct meshes from domains and other parameters.
SIGNATURE
def simple_mesh_selector(
    domain: _domain.Domain,
    background_model: model.background._BackgroundBase,
    min_vertical_coordinate: float,
    max_vertical_coordinate: float,
    mesh_configuration: MeshConfiguration,
    bm_shift: float = 0.0,
    execution_policy: bindings.ExecutionPolicy = salvus._core.lib.salvus_core_python_bindings.ExecutionPolicy,
) -> UnstructuredMesh: ...
ARGUMENTS
Required
domain
Type:_domain.Domain
Description:
Domain.
Required
background_model
Type:model.background._BackgroundBase
Description:
Background model.
Required
min_vertical_coordinate
Type:float
Description:
The minimum vertical coordinate in the mesh.
Required
max_vertical_coordinate
Type:float
Description:
The maximum vertical coordinate in the mesh.
Required
mesh_configuration
Type:MeshConfiguration
Description:
The mesh configuration.
Optional
bm_shift
Type:float
Default value:0.0
Description:
For UTM domains -- shift away from the reference datum.
Optional
execution_policy
Type:bindings.ExecutionPolicy
Default value:<salvus._core.lib.salvus_core_python_bindings.ExecutionPolicy object at 0x7c0325d5c130>
Description:
Execution policy governing the maximum allowable parallelism of child routines.
RETURNS
Return type: UnstructuredMesh
Previous
dim3
Next
project
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