User data block

Listing 18 User Data block in XML input file.

  <ParameterList name="User Data">
	  ...
	  ...
	  ...
  </ParameterList> <!--User Data-->

Output Graph

Type:

bool

Value:

True or False

Usage:

Required

Description:

Output the Panzer graph. Useful when debugging.

    <Parameter name="Output Graph" type="bool" value="false"/>

Workset Size

Type:

integer

Value:

\([0;\infty]\)

Usage:

Required

Description:

Set the workset size as defined by Trilinos. On CPUs, the workset size is typically set to 256. On GPUs, the workset size is set to larger values (1000-4000). Note that the workset size is machine/problem dependent. It is recommended to perform a sensitivity of the solver to the workset size for optimal performance.

    <Parameter name="Workset Size" type="int" value="256"/>

CFL

Type:

double

Value:

\([0;\infty]\)

Usage:

Optional

Default:

None

Description:

CFL condition for transient solver.

CFL_init

Type:

double

Value:

\([0;\infty]\)

Usage:

Optional

Default:

CFL value

Description:

Initial value of CFL condition to use when ramping CFL.

CFL_transition

Type:

double

Value:

\([0;\infty]\)

Usage:

Optional

Default:

0

Description:

Number of time steps to ramp the CFL condition over.

    <Parameter name="CFL" type="double" value="100"/>
    <Parameter name="CFL_init" type="double" value="0.1"/>
    <Parameter name="CFL_transition" type="double" value="100"/>

Gravity

Type:

array(double)

Value:

Vector of real value

Usage:

Optional

Default:

None

Description:

Gravity vector.

    <Parameter name="Gravity" type="Array(double)" value="{0.0, -9.80665}"/>

Wall Names

Type:

string

Value:

List of side set names.

Usage:

Required if using Spalart-Allmaras, K-Epsilon, and K-Omega SST turbulence models.

Default:

None

Description:

List of side set names to compute the wall distance from. Names are separated with commas (e.g., “wall1, wall2, wall3”) and must be the same names as defined in the mesh file. This input parameter is needed by the WallDistance closure model.

    <Parameter name="Wall Names" type="string" value="top,bottom"/>

External Magnetic Field Parameters

External Magnetic Field Type

Type:

string

Value:

“constant”, “toroidal”, or “x_tanh”

Usage:

Optional

Default:

“constant”

Description:

External magnetic field type for MHD simulations.

External Magnetic Field Value

Type:

array(double)

Value:

Vector of real value

Usage:

Optional

Default:

None

Description:

External magnetic field value for MHD simulations.

    <ParameterList name="External Magnetic Field Parameters">
      <Parameter name="External Magnetic Field Value" type="Array(double)" value="{0.0, 1.0, 0.0}"/>
    </ParameterList> <!-- External Magnetic Field Parameters -->

External Magnetic Field Time Rate of Change

Type:

array(double)

Value:

Vector of real value

Usage:

Required with External Magnetic Field Type = constant

Default:

0.0

Description:

External magnetic field change rate, \(\vec{B}_{dt}\), in the expression of \(\vec{B} = \vec{B}_{input} + \vec{B}_{dt} t\), where \(\vec{B}_{input}\) is the initial magnetic field value and \(\vec{B}_{dt}\) is the rate of change.

Toroidal Field Magnitude

Type:

double

Value:

\([-\infty;\infty]\)

Usage:

Required with External Magnetic Field Type = toroidal

Default:

None

Description:

External magnetic field value in toroidal direction for MHD simulations. If the external magnetic field type is “toroidal”, this parameter is required rather than the “External Magnetic Field Value”.

External Magnetic Field Distribution Offset

Type:

double

Value:

\([-\infty;\infty]\)

Usage:

Required with External Magnetic Field Type = x_tanh

Default:

None

Description:

This parameter sets the offset, \(\beta\), in the distribution given as \(\vec{B} = \vec{b} (1-tanh(-(x/\alpha-\beta)))/2\), where \(\vec{b}\) is the maximum external magnetic field value and \(\vec{B}\) is the x-varying external magnetic field value.

External Magnetic Field Distribution Curvature Coefficient

Type:

double

Value:

\([-\infty;\infty]\)

Usage:

Required with External Magnetic Field Type = x_tanh

Default:

None

Description:

This parameter controls the curvature of the distribution. This corresponds to \(\alpha\) in the distribution given as \(\vec{B} = \vec{b} (1-tanh(-(x/\alpha-\beta)))/2\), where \(\vec{b}\) is the maximum external magnetic field value and \(\vec{B}\) is the x-varying external magnetic field value.

Compute Error Norms

Output Frequency

Type:

int

Value:

\([0; \infty]\)

Usage:

Optional

Default:

\(\infty\)

Description:

Set frequency to output error norms during transient.

Compute Time Integral

Type:

bool

Value:

True or False

Usage:

Optional

Default:

True

Description:

When enabled, error norms are accumulated over transient.

    <ParameterList name="Compute Error Norms">
      <Parameter name="Output Frequency" type="int" value="10"/>
      <Parameter name="Compute Time Integral" type="bool" value="false"/>
    </ParameterList> <!-- Compute Error Norms -->

Linear Solver Factory

Note

The Linear Solver Factory sublist is optional for back compatibility. When not specified, a single blocking strategy is employed where all variables are grouped into a single block which is equivalent to setting Type to Single Block.

Type

Type:

string

Value:

Single Block, DOF Blocking, Aggregation

Usage:

Optional

Default:

Single Block

Description:

Set preconditioner strategy for the equations to solve.

Write coordinates

Type:

bool

Value:

True or False

Usage:

Optional

Default:

False

Description:

Compute coordinates of mesh nodes to be passed to the AMG solver which can be used for coarsening and aggregation steps.

Write topology

Type:

bool

Value:

True or False

Usage:

Optional

Default:

False

Description:

Write the topology of the blocked linear system for debugging and diagnostic: field ordering, blocking strategy of variables, mapping between field names and blocked indices, and connectivity between blocks.

DOF Blocking

DOFs

Type:

string

Value:

variable name

Usage:

Required if Type is set to DOF Blocking.

Description:

List a variable to be grouped into a single block. It is added to the XML input file as an un-named sublist.

DOFs

Type:

Array(string)

Value:

list of variable names

Usage:

Required if Type is set to DOF Blocking.

Description:

List variables to be grouped together. It is added to the XML input file as an un-named sublist.

Listing 19 Blocking strategy for a 2D rotating flow in concentric cylinders. Pressure and velocity are blocked together while temperature is treated as an independent scalar block.

    <ParameterList name="Linear Solver Factory">
      <Parameter name="Type" type="string" value="DOF Blocking"/>
      <Parameter name="Write coordinates" type="bool" value="false"/>
      <Parameter name="Write topology" type="bool" value="false"/>
      <ParameterList name="DOF Blocking">
        <ParameterList>
          <Parameter name="DOFs" type="Array(string)" value="{lagrange_pressure, velocity_0, velocity_1}"/>
        </ParameterList> <!-- -->
        <ParameterList>
          <Parameter name="DOFs" type="string" value="temperature"/>
        </ParameterList> <!-- -->
      </ParameterList> <!-- DOF Blocking -->
    </ParameterList> <!-- Linear Solver Factory -->

Listing 20 Blocking strategy for a 3D Rayleigh Benard convection case. Velocity components are blocked together. Pressure and temperature are treated in independent scalar blocks..

    <ParameterList name="Linear Solver Factory">
      <Parameter name="Type" type="string" value="DOF Blocking"/>
      <ParameterList name="DOF Blocking">
        <ParameterList>
          <Parameter name="DOFs" type="Array(string)" value="{velocity_0, velocity_1, velocity_2}"/>
        </ParameterList> <!-- -->
        <ParameterList>
          <Parameter name="DOFs" type="string" value="lagrange_pressure"/>
        </ParameterList> <!-- -->
        <ParameterList>
          <Parameter name="DOFs" type="string" value="temperature"/>
        </ParameterList> <!-- -->
      </ParameterList> <!-- DOF Blocking -->
    </ParameterList> <!-- Linear Solver Factory -->