Adiabatic conditions model#

Subsection: Adiabatic conditions model#

Parameter name: Model name#

Default value: compute profile

Pattern: [Selection ascii data|compute entropy profile|compute profile|function ]

Documentation: Select one of the following models:

‘ascii data’: A model in which the adiabatic profile is read from a file that describes the reference state. Note the required format of the input data: The first lines may contain any number of comments if they begin with ‘#’, but one of these lines needs to contain the number of points in the reference state as for example ‘# POINTS: 3’. Following the comment lines there has to be a single line containing the names of all data columns, separated by arbitrarily many spaces. Column names are not allowed to contain spaces. The file can contain unnecessary columns, but for this plugin it needs to at least provide columns named ‘temperature’, ‘pressure’, and ‘density’. Note that the data lines in the file need to be sorted in order of increasing depth from 0 to the maximal depth in the model domain. Points in the model that are outside of the provided depth range will be assigned the maximum or minimum depth values, respectively. Points do not need to be equidistant, but the computation of properties is optimized in speed if they are.

‘compute entropy profile’: A model in which the adiabatic profile is calculated by solving the hydrostatic equations for pressure and entropy in depth. Of course the entropy along an adiabat is constant. This plugin requires the material model to provide an additional output object of type PrescribedTemperatureOutputs. It also requires that there is a compositional field of type ’entropy’ that represents the entropy of the material.

‘compute profile’: A model in which the adiabatic profile is calculated by solving the hydrostatic equations for pressure and temperature in depth. The gravity is assumed to be in depth direction and the composition is either given by the initial composition at reference points or computed as a reference depth-function. All material parameters are computed by the material model plugin. The surface conditions are either constant or changing over time as prescribed by a user-provided function.

‘function’: A model in which the adiabatic profile is specified by a user defined function. The supplied function has to contain temperature, pressure, and density as a function of depth in this order.

Subsection: Adiabatic conditions model / Ascii data model#

Parameter name: Data directory#

Default value: $ASPECT_SOURCE_DIR/tests/adiabatic-conditions/ascii-data/test/

Pattern: [DirectoryName]

Documentation: The name of a directory that contains the model data. This path may either be absolute (if starting with a ‘/’) or relative to the current directory. The path may also include the special text ‘$ASPECT_SOURCE_DIR’ which will be interpreted as the path in which the ASPECT source files were located when ASPECT was compiled. This interpretation allows, for example, to reference files located in the ‘data/’ subdirectory of ASPECT.

Parameter name: Data file name#

Default value:

Pattern: [Anything]

Documentation: The file name of the model data.

Parameter name: Scale factor#

Default value: 1.

Pattern: [Double -MAX_DOUBLE…MAX_DOUBLE (inclusive)]

Documentation: Scalar factor, which is applied to the model data. You might want to use this to scale the input to a reference model. Another way to use this factor is to convert units of the input files. For instance, if you provide velocities in cm/yr set this factor to 0.01.

Subsection: Adiabatic conditions model / Compute entropy profile#

Parameter name: Number of points#

Default value: 1000

Pattern: [Integer range 5…2147483647 (inclusive)]

Documentation: The number of points we use to compute the adiabatic profile. The higher the number of points, the more accurate the downward integration from the adiabatic surface conditions will be.

Parameter name: Surface entropy#

Default value: 0

Pattern: [Double -MAX_DOUBLE…MAX_DOUBLE (inclusive)]

Documentation: The surface entropy for the profile.

Subsection: Adiabatic conditions model / Compute profile#

Parameter name: Composition reference profile#

Default value: initial composition

Pattern: [Selection initial composition|function ]

Documentation: Select how the reference profile for composition is computed. This profile is used to evaluate the material model, when computing the pressure and temperature profile.

Parameter name: Function constants#

Default value:

Pattern: [Anything]

Documentation: Sometimes it is convenient to use symbolic constants in the expression that describes the function, rather than having to use its numeric value everywhere the constant appears. These values can be defined using this parameter, in the form ‘var1=value1, var2=value2, …’.

A typical example would be to set this runtime parameter to ‘pi=3.1415926536’ and then use ‘pi’ in the expression of the actual formula. (That said, for convenience this class actually defines both ‘pi’ and ‘Pi’ by default, but you get the idea.)

Parameter name: Function expression#

Default value: 0

Pattern: [Anything]

Documentation: The formula that denotes the function you want to evaluate for particular values of the independent variables. This expression may contain any of the usual operations such as addition or multiplication, as well as all of the common functions such as ‘sin’ or ‘cos’. In addition, it may contain expressions like ‘if(x>0, 1, -1)’ where the expression evaluates to the second argument if the first argument is true, and to the third argument otherwise. For a full overview of possible expressions accepted see the documentation of the muparser library at http://muparser.beltoforion.de/.

If the function you are describing represents a vector-valued function with multiple components, then separate the expressions for individual components by a semicolon.

Parameter name: Number of points#

Default value: 1000

Pattern: [Integer range 5…2147483647 (inclusive)]

Documentation: The number of points we use to compute the adiabatic profile. The higher the number of points, the more accurate the downward integration from the adiabatic surface temperature will be.

Parameter name: Use surface condition function#

Default value: false

Pattern: [Bool]

Documentation: Whether to use the ’Surface condition function’ to determine surface conditions, or the ’Adiabatic surface temperature’ and ’Surface pressure’ parameters. If this is set to true the reference profile is updated every timestep. The function expression of the function should be independent of space, but can depend on time ’t’. The function must return two components, the first one being reference surface pressure, the second one being reference surface temperature.

Parameter name: Variable names#

Default value: x,t

Pattern: [Anything]

Documentation: The names of the variables as they will be used in the function, separated by commas. By default, the names of variables at which the function will be evaluated are ‘x’ (in 1d), ‘x,y’ (in 2d) or ‘x,y,z’ (in 3d) for spatial coordinates and ‘t’ for time. You can then use these variable names in your function expression and they will be replaced by the values of these variables at which the function is currently evaluated. However, you can also choose a different set of names for the independent variables at which to evaluate your function expression. For example, if you work in spherical coordinates, you may wish to set this input parameter to ‘r,phi,theta,t’ and then use these variable names in your function expression.

Subsection: Adiabatic conditions model / Compute profile / Surface condition function#

Parameter name: Function constants#

Default value:

Pattern: [Anything]

Documentation: Sometimes it is convenient to use symbolic constants in the expression that describes the function, rather than having to use its numeric value everywhere the constant appears. These values can be defined using this parameter, in the form ‘var1=value1, var2=value2, …’.

A typical example would be to set this runtime parameter to ‘pi=3.1415926536’ and then use ‘pi’ in the expression of the actual formula. (That said, for convenience this class actually defines both ‘pi’ and ‘Pi’ by default, but you get the idea.)

Parameter name: Function expression#

Default value: 0; 0

Pattern: [Anything]

Documentation: The formula that denotes the function you want to evaluate for particular values of the independent variables. This expression may contain any of the usual operations such as addition or multiplication, as well as all of the common functions such as ‘sin’ or ‘cos’. In addition, it may contain expressions like ‘if(x>0, 1, -1)’ where the expression evaluates to the second argument if the first argument is true, and to the third argument otherwise. For a full overview of possible expressions accepted see the documentation of the muparser library at http://muparser.beltoforion.de/.

If the function you are describing represents a vector-valued function with multiple components, then separate the expressions for individual components by a semicolon.

Parameter name: Variable names#

Default value: x,t

Pattern: [Anything]

Documentation: The names of the variables as they will be used in the function, separated by commas. By default, the names of variables at which the function will be evaluated are ‘x’ (in 1d), ‘x,y’ (in 2d) or ‘x,y,z’ (in 3d) for spatial coordinates and ‘t’ for time. You can then use these variable names in your function expression and they will be replaced by the values of these variables at which the function is currently evaluated. However, you can also choose a different set of names for the independent variables at which to evaluate your function expression. For example, if you work in spherical coordinates, you may wish to set this input parameter to ‘r,phi,theta,t’ and then use these variable names in your function expression.

Subsection: Adiabatic conditions model / Function#

Parameter name: Function constants#

Default value:

Pattern: [Anything]

Documentation: Sometimes it is convenient to use symbolic constants in the expression that describes the function, rather than having to use its numeric value everywhere the constant appears. These values can be defined using this parameter, in the form ‘var1=value1, var2=value2, …’.

A typical example would be to set this runtime parameter to ‘pi=3.1415926536’ and then use ‘pi’ in the expression of the actual formula. (That said, for convenience this class actually defines both ‘pi’ and ‘Pi’ by default, but you get the idea.)

Parameter name: Function expression#

Default value: 0.0; 0.0; 1.0

Pattern: [Anything]

Documentation: Expression for the adiabatic temperature, pressure, and density separated by semicolons as a function of ‘depth’.

Parameter name: Variable names#

Default value: depth

Pattern: [Anything]

Documentation: