API for Globe3D type meshes

Salvus version: 2024.1.1

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

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

Advanced Parameters group [advanced]

Advanced mesh parameters.

Required: True

Detailed description of all parameters:

• courant_number

  • Pretty name: Courant Number

  • Description: Courant Number.

  • Parameter type: number

  • Required: True

  • Default: 0.6

• model_parameters

  • Pretty name: Model Parameters

  • Description: Model parameters.

  • 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"

• tensor_order

  • Pretty name: Tensor Order

  • Description: Tensor order for the shape and material parameters.

  • Parameter type: integer

  • Required: True

  • Default: 1

Attenuation Arguments group [attenuation]

Parameters related to attenuation.

Required: True

Detailed description of all parameters:

• auto_band

  • Pretty name: Automatic frequency band determination.

  • Description: Automatically determine the frequency band.

  • Parameter type: boolean

  • Required: True

  • Default: true

• frequencies

  • Pretty name: Frequeny Band

  • Description: Frequency band for the linear solids.

  • Parameter type: array of numbers

  • Required: False

  • Default: [0.001, 1.0]

• number_of_linear_solids

  • Pretty name: Number of Linear Solids

  • Description: The number of linear solids used.

  • Parameter type: integer

  • Required: True

  • Default: 5

• power_law_alpha

  • Pretty name: Alphas for Power Law Alpha

  • Description: Exponent alpha for the power law.

  • Parameter type: number

  • Required: True

  • Default: 0.0

• power_law_reference_frequency

  • Pretty name: Reference Frequency for Power Law

  • Description: Refeference frequency for the power law.

  • Parameter type: number

  • Required: True

  • Default: 1.0

Basic Parameters group [basic]

Basic parameters that must always be given.

Required: True

Detailed description of all parameters:

• elements_per_wavelength

  • Pretty name: Elements per Wavelength

  • Description: Number of elements per wavelength

  • Parameter type: number

  • Required: True

• min_period_in_seconds

  • Pretty name: Minimum Period in Seconds

  • Description: The minimum period of the mesh in seconds.

  • Parameter type: number

  • Required: True

• model

  • Pretty name: Model

  • Description: The background model name or file.

  • Parameter type: string

  • Required: True

Ocean Arguments group [ocean]

Arguments for ocean meshes.

Required: True

Detailed description of all parameters:

• bathymetry_file

  • Pretty name: Bathymetry Filename

  • Description: Filename for bathymetry, see here

  • Parameter type: string

  • Required: True

  • Default: ""

• bathymetry_varname

  • Pretty name: Bathymetry Variable name

  • Description: Variable name inside the bathymetry file

  • Parameter type: string

  • Required: True

  • Default: ""

• ocean_layer_cutoff

  • Pretty name: Ocean Layer Cutoff

  • Description: Smaller elements will not be added.

  • Parameter type: number

  • Required: True

  • Default: 1.0

• ocean_layer_density

  • Pretty name: Ocean Layer Density

  • Description: Ocean density in kg/m**3.

  • Parameter type: number

  • Required: True

  • Default: 1020.0

• ocean_layer_maximum_element_oversize

  • Pretty name: Ocean Layer Maximum Element Oversize

  • Description: Maximum oversize in the lateral element dimension in the ocean layer, 1 meaning fully resolving all waves and larger values referg to the aspect ratio. A natural additional maximum to this is given by the ratio of vs in the crust to vp in the water.

  • Parameter type: number

  • Required: True

  • Default: 10.0

• ocean_layer_style

  • Pretty name: Ocean Layer Meshing Style

  • Description: Determine how to add the ocean layer.

  • Parameter type: string

  • Required: True

  • Default: "none"

  • Possible values: "none", "loading", "extrude", "anisotropic_doubling", "anisotropic_tripling"

• ocean_layer_vp

  • Pretty name: Ocean Layer vp

  • Description: P-wave velocity in the ocean in m/s.

  • Parameter type: number

  • Required: True

  • Default: 1450.0

• shore_smoothing_factor

  • Pretty name: Shore smoothing factor

  • Description: Shore smoothing. Does not really work.

  • Parameter type: number

  • Required: True

  • Default: 0.0

Refinement Arguments group [refinement]

Parameters for refinement of spherical 2D meshes.

Required: True

Detailed description of all parameters:

• hmax_refinement

  • Pretty name: h-max Refinement

  • Description: Move refinement layers based on this criterion.

  • Parameter type: number

  • Required: True

  • Default: 1.5

• horizontal_max_slowness_layer_index

  • Pretty name: Horizontal maximum slowness layer index (EXPERIMENTAL)

  • Description: For low velocity layers at the surface, horizontal refinements can be avoided if the source is below the LVL and hence cannot excite waves above a certain slowness. This is a 1D argument and might not me valid in 3D, hence check carefully. Ignored for 'local' refinement styles, if available.

  • Parameter type: integer

  • Required: True

  • Default: 0

• refinement_bottom_up

  • Pretty name: Refinement Bottom Up

  • Description: Refine from the bottom.

  • Parameter type: boolean

  • Required: True

  • Default: false

• refinement_style

  • Pretty name: Refinement Style

  • Description: The mesh refinement style.

  • Parameter type: string

  • Required: True

  • Default: "doubling"

  • Possible values: "doubling", "tripling"

Spherical Arguments group [spherical]

Parameters for 3D spherical meshes.

Required: True

Detailed description of all parameters:

• ellipticity

  • Pretty name: Ellipticity

  • Description: Ellipticity of the sphere.

  • Parameter type: number

  • Required: True

  • Default: 0.0

• min_radius

  • Pretty name: Minimum radius.

  • Description: Min radius of the sphere in km.

  • Parameter type: number

  • Required: True

  • Default: 0.0

Topography Arguments group [topography]

Adding topography to the mesh.

Required: True

Detailed description of all parameters:

• anisotropic_refinement_style

  • Pretty name: Anisotropic Refinement Style

  • Description: Use anisotropic refinements.

  • Parameter type: string

  • Required: True

  • Default: "none"

  • Possible values: "doubling", "tripling", "none"

• 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: Variable name inside the moho topography file

  • Parameter type: string

  • Required: True

  • Default: ""

• 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: Variable name inside the topography file

  • Parameter type: string

  • Required: True

  • Default: ""