Scalar Response Output

Listing 3 Scalar Response Output block in XML input file.
1<ParameterList name="Scalar Response Output">
2       ...
3       ...
4       ...
5</ParameterList> <!-- Scalar Response Output -->

Note

Scalar responses integrate a field over a mesh block or sideset but are not normalized by the corresponding volume or surface area. Therefore, for verification or validation studies, users must perform the normalization themselves.

Output Frequency
Type:

integer

Value:

\((0;\infty]\)

Usage:

Optional

Default:

\(\infty\)

Description:

Set the default frequency or high-level frequency of output for all scalar response functions. Note that this Output Frequency input parameter is overwritten by the individual Output Frequency that can be specified in each scalar response output block.

Listing 4 Default frequency output for all scalar response outputs.
1<Parameter name="Output Frequency"  type="int" value="1"/>
<User defined response function name for a mesh block>
Field Name
Type:

string

Value:

List of field names to integrate over a mesh block or a sideset, separated by a comma.

Usage:

Required

Description:

List of field names to integrate over a mesh block or a sideset. The field name can be a nodal field (velocity, temperature, density, or species) or an element field (pressure, entropy, total energy, residuals, etc …). Note that any fields defined at quadrature points or mesh nodes in the source code can be listed under field name.

Output Frequency
Type:

integer

Value:

\((0;\infty]\)

Usage:

Optional

Default:

Same as the high level Output Frequency input parameter specified in the Scalar Response Output XML block.

Description:

Individual output frequency of this scalar response output.

Element Blocks
Type:

string

Value:

List of mesh block ids/names separated by a comma.

Usage:

Optional

Default:

all mesh blocks defined in the Exodus mesh file.

Description:

List of block mesh ids/names (as defined in the Exodus mesh file) separated by a comma over which the response will be computed. Note that when using the Inline mesh option, mesh blocks ids are labeled with eblock-X_Y and eblock-X_Y_Z for 2D and 3D geometries, respectively, where X, Y and Z denote the mesh block id in the Cartesian directions. For instance, when using a mesh with two mesh blocks in the x-direction, X will range from 0 to 1.

Listing 5 Scalar response output that integrates the divergence of the induced magnetic field and its absolute value over the block eblock-0_0-quad and output the scalar response value every other time step.
1    <ParameterList name="Magn Field Divergence">
2      <Parameter name="Field Name" type="string" value="divergence_induced_magnetic_field"/>
3      <Parameter name="Element Blocks" type="string" value="eblock-0_0-quad"/>
4    </ParameterList> <!-- Magn Field Divergence -->
5    <ParameterList name="Abs Magn Field Divergence">
6      <Parameter name="Field Name" type="string" value="abs_divergence_induced_magnetic_field"/>
7      <Parameter name="Element Blocks" type="string" value="eblock-0_0-quad"/>
8    </ParameterList> <!-- Abs Magn Field Divergence -->
Listing 6 Solver output for the scalar responses at time steps 3 and 4. The Magn Field Divergence and Abs Magn Field Divergence responses are outputed every time step. Note that the input syntax can be simplified by using a unique sublist and listing Magn Field Divergence and Abs Magn Field Divergence under Field Name.
 1Time Step = 3; Order = 2
 2CFL = 2.098e+01; dt = 3.015e-03; Time = 1.738427232901e-03
 3 | Nonlinear | F 2-Norm | # Linear | R 2-Norm |
 4     0   1.74e-01
 5     1   5.23e-05         50   9.27e-07
 6     2   1.32e-10         57   9.39e-07
 7     3   5.94e-15         63   9.17e-07
 8 | Nonlinear | F 2-Norm | # Linear | R 2-Norm |
 9     0   2.97e-01
10     1   1.38e-04         50   9.40e-07
11     2   5.98e-10         56   9.59e-07
12     3   7.11e-15         63   9.95e-07
13 Time step time to completion (s): 1.55e+00
14 Scalar Responses:
15   Magn Field Divergence - divergence_induced_magnetic_field = 3.255595976375978e-06
16   Abs Magn Field Divergence - abs_divergence_induced_magnetic_field = 0.00099132620736235
17
18 Time Step = 4; Order = 2
19 CFL = 3.097e+01; dt = 4.454e-03; Time = 4.753628455579e-03
20  | Nonlinear | F 2-Norm | # Linear | R 2-Norm |
21     0   1.04e-01
22     1   3.31e-05         72   9.22e-07
23     2   4.55e-11         79   8.75e-07
24     3   5.70e-15         92   9.14e-07
25 | Nonlinear | F 2-Norm | # Linear | R 2-Norm |
26     0   2.32e-01
27     1   1.07e-04         72   8.63e-07
28     2   2.94e-10         78   9.05e-07
29     3   6.17e-15         91   9.86e-07
30 Time step time to completion (s): 1.59e+00
31 Scalar Responses:
32   Magn Field Divergence - divergence_induced_magnetic_field = 1.895992002556518e-06
33   Abs Magn Field Divergence - abs_divergence_induced_magnetic_field = 0.001797021397254495
<User defined response function name for a sideset>
Field Name
Type:

string

Value:

List of field names to integrate over a mesh block or a sideset, separated by a comma.

Usage:

Required

Description:

List of field names to integrate over a mesh block or a sideset. The field name can be a nodal field (velocity, temperature, density, or species) or an element field (pressure, entropy, total energy, residuals, etc …). Note that any fields defined at quadrature points or mesh nodes in the source code can be listed under field name.

Output Frequency
Type:

integer

Value:

\((0;\infty]\)

Usage:

Optional

Default:

Same as the high level Output Frequency input parameter specified in the Scalar Response Output XML block.

Description:

Individual output frequency of this scalar response output.

Sidesets
<Block name>
Type:

string

Value:

sideset name.

Usage:

Required when not using Element Blocks.

Description:

Name of the sideset as defined in the Exodus mesh file to surface-integrate the field specified in Field Name over. The block name is specified as the name of the XML syntax, while the sideset name is specified as the value.

Listing 7 Scalar response computing the surface-integrated value of the x-component of the aerodynamic forces acting on the sideset airfoil that belongs to the mesh block block_1. As the Output Frequency input parameter is not specified, the default Output Frequency value is employed.
1    <ParameterList name="Force">
2      <Parameter name="Field Name" type="string" value="pressure_force_0, total_force_0, shear_tensor_0, viscous_force_0, pressure_force_1, total_force_1, shear_tensor_1, viscous_force_1"/>
3      <ParameterList name="Sidesets">
4        <Parameter name="block_1" type="string" value="wall"/>
5      </ParameterList> <!-- Sidesets -->
6    </ParameterList> <!-- Force -->
Listing 8 Solver output for the scalar responses listed in Listing 7 at time step 480. A response function is listed for each field name listed in the Field Names input parameter.
 1Time Step = 480; Order = 1
 2CFL = 4.000e+02; dt = 6.398e-01; Time = 1.776498438e+02
 3 | Nonlinear | F 2-Norm | # Linear | R 2-Norm |
 4     0   7.64e-04
 5     1   7.60e-08        230   9.95e-05
 6 Time step time to completion (s): 2.39e+00
 7 Scalar Responses:
 8   Force - pressure_force_0 = 0.03211895605248266
 9   Force - total_force_0 = 0.06949613817519235
10   Force - shear_tensor_0 = -37.37718212270967
11   Force - viscous_force_0 = 0.03737718212270966
12   Force - pressure_force_1 = 0.1590301014128794
13   Force - total_force_1 = 0.1600614074958627
14   Force - shear_tensor_1 = -1.031306082983392
15   Force - viscous_force_1 = 0.001031306082983394
<Name of probe>

Caution

The probes logic only works with nodal variables and on CPUs.

Note

The name of the scalar response block <Name of probe> in the XML input file is user-defined.

Field Name
Type:

string

Value:

List of field names to integrate over a mesh block or a sideset, separated by a comma.

Usage:

Required

Description:

List of field names to integrate over a mesh block or a sideset. The field name can be a nodal field (velocity, temperature, density, or species) or an element field (pressure, entropy, total energy, residuals, etc …). Note that any fields defined at quadrature points or mesh nodes in the source code can be listed under field name.

Output Frequency
Type:

integer

Value:

\((0;\infty]\)

Usage:

Optional

Default:

Same as the high level Output Frequency input parameter specified in the Scalar Response Output XML block.

Description:

Individual output frequency of this scalar response output.

Probe Coordinates
Probe <N>
Type:

Array(double)

Value:

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

Usage:

Required

Description:

Cartesian coordinates of the :math:N^{text{th}} probe. Multiple probe entries can be specified with different names following the nomenclature Probe i, where i is the probe index. Note that the probe indices must be consecutive starting from 1.

Listing 9 Probes to extract temperature values at specific locations within eblock-0_0 and on the sideset right. The sublist named Probe Upper will extract the values of the temperature at two different locations specified with Probe 1 and Probe 2.
 1    <ParameterList name="Probe Upper">
 2      <Parameter name="Field Name" type="string" value="temperature"/>
 3      <Parameter name="Element Blocks" type="string" value="eblock-0_0"/>
 4      <ParameterList name="Probe Coordinates">
 5        <Parameter name="Probe 1" type="Array(double)" value="{0.4, 0.05}"/>
 6        <Parameter name="Probe 2" type="Array(double)" value="{0.2, 0.05}"/>
 7      </ParameterList> <!-- Probe Coordinates -->
 8    </ParameterList> <!-- Probe Upper -->
 9    <ParameterList name="Probe Right">
10      <Parameter name="Field Name" type="string" value="temperature"/>
11      <Parameter name="Output Frequency" type="int" value="50"/>
12      <ParameterList name="Probe Coordinates">
13        <Parameter name="Probe 1" type="Array(double)" value="{0.8, 0.0}"/>
14      </ParameterList> <!-- Probe Coordinates -->
15      <ParameterList name="Sidesets">
16        <Parameter name="eblock-0_0" type="string" value="right"/>
17      </ParameterList> <!-- Sidesets -->
18    </ParameterList> <!-- Probe Right -->
Listing 10 Solver output for the scalar response output block specified in Listing 9.
 1Time Step = 100; Order = 1
 2CFL = 9.102e+01; dt = 1.000e+02; Time = 9.90000000e+03
 3| Nonlinear | F 2-Norm | # Linear | R 2-Norm |
 4     0   8.48e-01
 5     1   7.69e-07        295   9.76e-11
 6     2   1.11e-11        429   9.83e-11
 7Time step time to completion (s): 1.30e+00
 8Scalar Responses:
 9  Probe Upper 1 - temperature = 20.65953897897253
10  Probe Upper 2 - temperature = 20.03235001130465
11  Probe Right 1 - temperature = 20.00184327047455