Boundary heat flux model#

Subsection: Boundary heat flux model#

Parameter name: Fixed heat flux boundary indicators#

Default value:

Pattern: [List of <[Anything]> of length 0…4294967295 (inclusive)]

Documentation: A comma separated list of names denoting those boundaries on which the heat flux is fixed and described by the boundary heat flux object selected in the ’Model name’ parameter. All boundary indicators used by the geometry but not explicitly listed here or in the list of ’Fixed temperature boundary indicators’ in the ’Boundary temperature model’ will end up with no-flux (insulating) boundary conditions.

The names of the boundaries listed here can either be numbers (in which case they correspond to the numerical boundary indicators assigned by the geometry object), or they can correspond to any of the symbolic names the geometry object may have provided for each part of the boundary. You may want to compare this with the documentation of the geometry model you use in your model.

This parameter only describes which boundaries have a fixed heat flux, but not what heat flux should hold on these boundaries. The latter piece of information needs to be implemented in a plugin in the BoundaryHeatFlux group, unless an existing implementation in this group already provides what you want.

Parameter name: Model name#

Default value: function

Pattern: [Selection function ]

Documentation: Select one of the following plugins:

‘function’: Implementation of a model in which the boundary heat flux is given in terms of an explicit formula that is elaborated in the parameters in section “Boundary heat flux model|Function”. The format of these functions follows the syntax understood by the muparser library, see Section~\ref{sec:muparser-format}.

The formula you describe in the mentioned section is a scalar value for the heat flux that is assumed to be the flux normal to the boundary, and that has the unit W/(m\(^2\)) (in 3d) or W/m (in 2d). Negative fluxes are interpreted as the flow of heat into the domain, and positive fluxes are interpreted as heat flowing out of the domain.

The symbol \(t\) indicating time that may appear in the formulas for the prescribed heat flux is interpreted as having units seconds unless the global parameter “Use years in output instead of seconds” has been set.

Subsection: Boundary heat flux model / Function#

Parameter name: Coordinate system#

Default value: cartesian

Pattern: [Selection cartesian|spherical|depth ]

Documentation: A selection that determines the assumed coordinate system for the function variables. Allowed values are ‘cartesian’, ‘spherical’, and ‘depth’. ‘spherical’ coordinates are interpreted as r,phi or r,phi,theta in 2D/3D respectively with theta being the polar angle. ‘depth’ will create a function, in which only the first parameter is non-zero, which is interpreted to be the depth of the point.

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

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,y,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.