API for TidalLoading type meshes

Salvus version: 0.12.16

This document describes all the various parameters and settings for meshes of the TidalLoading type available when using the simple_mesh interface of SalvusMesh:

Copy
from salvus.mesh import simple_mesh
m = simple_mesh.TidalLoading(...)
# Accessing the elements_per_wavelength parameter in the basic group
m.basic.elements_per_wavelength = 2.0

Basic Parameters group [basic]

The most important parameters for tidal loading simulations.

Required: True

Detailed description of all parameters:

• model

  • Pretty name: Model

  • Description: Model Name for predefined models or filename for external model file.

  • Parameter type: string

  • Required: True

  • Default: "prem_iso_one_crust"

• nex

  • Pretty name: NEX

  • Description: Number of elements along one edge of the cubed sphere at the surface, needs to be a multiple of 3.

  • Parameter type: integer

  • Required: True

  • Default: 18

• mantle_refinement_index

  • Pretty name: Mantle Refinement Index

  • Description: index of the discontinuity in the mantle below which to refine counting from top and starting from 0.

  • Parameter type: integer

  • Required: True

  • Default: 6

• coarsen_cmb

  • Pretty name: Coarsen at CMB.

  • Description: Coarsen the mesh at the CMB, i.e. use larger elements in the core.

  • Parameter type: boolean

  • Required: True

  • Default: false

• tidal_loading_file

  • Pretty name: Load model

  • Description: Filename for load model.

  • Parameter type: string

  • Required: True

  • Default: ""

• tidal_loading_lmax_1

  • Pretty name: tidal loading max l in region of interest

  • Description: tidal loading max l in region of interest

  • Parameter type: integer

  • Required: True

  • Default: 128

• tidal_loading_lmax_2

  • Pretty name: tidal loading max l outside of region of interest

  • Description: tidal loading max l outside of region of interest

  • Parameter type: integer

  • Required: True

  • Default: 64

• region_of_interest

  • Pretty name: Region of interest

  • Description: Region of interest, [lat, lon, radius, taper width] in degree

  • Parameter type: array of numbers

  • Required: True

  • Default: [0.0, 0.0, 180.0, 10.0]

• nelem_vertical

  • Pretty name: Number elements in vertical direction

  • Description: Number of elements in vertical direction in the layers starting from the top.

  • Parameter type: array of integers

  • Required: False

  • Default: []

• local_refinement_level

  • Pretty name: Local Refinement Level

  • Description: Level of local gradient based edge refinement at the surface.

  • Parameter type: integer

  • Required: True

  • Default: 0

• global_refinement_level

  • Pretty name: Global Refinement Level

  • Description: Level of global gradient based edge refinement at the surface.

  • Parameter type: integer

  • Required: True

  • Default: 0

• refinement_threshold

  • Pretty name: Refineent Threshold

  • Description: Threshold for local refinement.

  • Parameter type: number

  • Required: True

  • Default: 0.01

Advanced Parameters group [advanced]

Advanced parameters for more control on tidal loading meshes.

Required: True

Detailed description of all parameters:

• tensor_order

  • Pretty name: Tensor Order

  • Description: Spatial order used for shape mapping and model representation.

  • Parameter type: integer

  • Required: True

  • Default: 1

• model_parameters

  • Pretty name: Model Parameters

  • Description: Model parameters to put into the mesh, defaults to the parametrization used by the 1D background model. This can be used for example to create an anisotropic parametrization of an isotropic model.

  • Parameter type: array of strings

  • Required: False

  • Default: []

  • Possible values: "g", "dg", "VP", "VS", "VSV", "VSH", "VPV", "VPH", "RHO", "QMU", "QKAPPA", "C11", "C12", "C13", "C14", "C15", "C16", "C21", "C22", "C23", "C24", "C25", "C26", "C31", "C32", "C33", "C34", "C35", "C36", "C41", "C42", "C43", "C44", "C45", "C46", "C51", "C52", "C53", "C54", "C55", "C56", "C61", "C62", "C63", "C64", "C65", "C66", "A", "C", "L", "N", "F", "XI", "PHI", "LAMBDA", "MU", "KAPPA", "ETA"

• velocity_model_representation

  • Pretty name: Velocity Model Representation

  • Description: How to represent the velocity model on the mesh. element_nodes: values are stored on each node of each element, allows discontinuities and variations inside each element, but produces large files. elements: one value per element, allows discontinuities but the model will be piecewise constant. nodes: one value per node, enforces a continuous model, using mean at values on discontinuities. The Salvus solver currently only supports 'element_nodes'.

  • Parameter type: string

  • Required: True

  • Default: "element_nodes"

  • Possible values: "element_nodes", "elements", "nodes"

• model_spline_order

  • Pretty name: Model Spline Order

  • Description: Spline order used for model interpolation in case of layered models. Ignored for polynomial models like PREM.

  • Parameter type: integer

  • Required: True

  • Default: 3

• compression

  • Pretty name: Compress Mesh

  • Description: If true, the final mesh will be compressed with gzip compression level 2. Compression is most effective for constant values and the compression level does matter much in that case. Slows down the mesh IO.

  • Parameter type: boolean

  • Required: True

  • Default: true

Topography Arguments group [topography]

Adding topography to the mesh.

Required: True

Detailed description of all parameters:

• topography_file

  • Pretty name: Topography Filename

  • Description: Filename for topography, see here

  • Parameter type: string

  • Required: True

  • Default: ""

• topography_varname

  • Pretty name: Topography Variable Name

  • Description: Variablename inside the topography file

  • Parameter type: string

  • Required: True

  • Default: ""

• moho_topography_file

  • Pretty name: Moho Topography Filename

  • Description: Filename for moho topography, see here

  • Parameter type: string

  • Required: True

  • Default: ""

• moho_topography_varname

  • Pretty name: Moho Topography Variable Name

  • Description: Variablename inside the moho topography file

  • Parameter type: string

  • Required: True

  • Default: ""

Spherical Arguments group [spherical]

Parameters for spherical meshes.

Required: True

Detailed description of all parameters:

• min_radius

  • Pretty name: Mimumum Radius

  • Description: Minimum radius in km.

  • Parameter type: number

  • Required: True

  • Default: 0.0

• ellipticity

  • Pretty name: Ellipticity

  • Description: Ellipticity of the planet (WGS84: 0.0033528106647474805, GRS80: 0.003352810681182319, MARS: 0.00589). If nonzero, the mesh will be deformed according to the Clairaut equation to match the given ellipticity at the surface.

  • Parameter type: number

  • Required: True

  • Default: 0.0

Exterior Domain group [gravity_mesh]

Adding the Exterior Domain for Gravity Computation. Implies including the whole planet with core.

Required: True

Detailed description of all parameters:

• add_exterior_domain

  • Pretty name: Add Exterior Domain Switch

  • Description: Switch for addition of exterior domain for the solution of the Poisson equation.

  • Parameter type: boolean

  • Required: True

  • Default: false

• ncoarse

  • Pretty name: Number of Coarsening Layers

  • Description: Number of coarsening layer between surface and outer boundary.

  • Parameter type: integer

  • Required: True

  • Default: 1

• nelem_buffer_surface

  • Pretty name: Number of Buffer Elements

  • Description: Number of buffer elements between the surface and the first coarsening layer.

  • Parameter type: integer

  • Required: True

  • Default: 1

• nelem_buffer_outer

  • Pretty name: Number of Buffer Elements

  • Description: Number of buffer elements between the last coarsening layer and the outer boundary.

  • Parameter type: integer

  • Required: True

  • Default: 5

• dr_basis

  • Pretty name: dr Basis

  • Description: Basis for power law dr in outer layer used to determine radial element size.

  • Parameter type: number

  • Required: True

  • Default: 1.5