32.2.1. Creating Report Definitions

You can create report definitions from multiple locations in Fluent, allowing you to quickly define report definitions, regardless of where you are in your workflow. The primary method to create a report definition is through the ribbon. For example:

 Solving → Reports → Definitions → New → Surface Report → Area-Weighted Average...

Opens the Surface Report Definition dialog box.

Alternative methods for accessing this dialog box are through the tree, by right-clicking the Report Definition branch, or through the New drop-down list in the Figure 32.1: Report Definitions Dialog Box.

Many of the setup steps are the same or similar when setting up the various types of report definitions.

To setup the Surface Report Definition dialog box:

  1. Enter a name for the report definition under Name.

  2. If you want the value reported on individual surfaces rather than the net results from a group of surfaces, enable the Per Surface option.

  3. (optional) To have Fluent calculate a running average for the Surface Report Definition you can enter a positive integer greater than 1 (the default) for Average Over.

    Specifying a number greater than 1 means that Fluent will print, plot, and write the running average value of the selected variable instead of the current value of the same variable.

    The value reported is averaged over the last iterations/time steps, where is your specified Average Over value. When the iteration/time step number is lower than , Fluent calculates the average of the available variable values.

  4. If you want the report definition written to a file or plotted, either select an existing report file or plot from the Report Files or Report Plots lists, or create a new report file or plot by enabling Report File and/or Report Plot in the Create group box.

  5. If you want the report definition available as an output parameter, enable Create Output Parameter.

  6. Choose the surface report definition integration method by selecting Area, Integral, Standard Deviation, Flow Rate, Mass Flow Rate, Volume Flow Rate, Area-Weighted Average, Mass-Weighted Average, Sum, Uniformity Index - Mass Weighted, Uniformity Index - Area Weighted, Facet Average, Facet Minimum, Facet Maximum, Vertex Average, Vertex Minimum, Vertex Maximum, Custom Vector Based Flux, Custom Vector Flux, or Custom Vector Weighted Average from the Report Type drop-down list. These methods are described in Surface Integration.

  7. If you selected Custom Vector Based Flux, Custom Vector Flux, or Custom Vector Weighted Average from the Report Type drop-down list, you must define the vectors in the Custom Vectors group box.

  8. Unless you are reporting a mass flow rate or volume flow rate, specify the variable or function to be integrated in the Field Variable drop-down list. First select the desired category in the upper drop-down list. You can then select one of the related quantities in the lower list. (See Field Function Definitions for an explanation of the variables in the list.) If you are running a multiphase simulation you may need to select the phase of interest (or mixture) from the Phase drop-down list (depending on the field variable selected).


    Note:
    • In general, you can select any arbitrary field variable for each report type. However, not all possible combinations are physically meaningful.

    • For multiphase flow, you should use only the Mass Flow Rate integral to compute the mass flow rate of the mixture or for an individual phase. Do not use the Flow Rate integral of the Volume Fraction field variable as this will result in erroneous results.


  9. Select the Surfaces where you want Fluent to evaluate the specified variable.

  10. You have the option to highlight a selected surface and have it displayed in the graphics window by enabling Highlight Surfaces.

  11. Click OK to create the report definition and close the dialog box.

Once you have created a report definition, it appears in the Figure 32.1: Report Definitions Dialog Box.

Figure 32.1:  Report Definitions Dialog Box

Report Definitions Dialog Box

You can use this dialog box to review and modify the properties of the existing report definitions.

The following sections detail setup instructions that are specific to each type of report definition.

32.2.1.1. Surface Report definitions

You can use the Figure 32.2: Surface Report Definition Dialog Box to create surface report definitions. There are many different types of surface-based report definitions that you can create, including:

  • Integral

  • Standard Deviation

  • Flow Rate

  • Mass Flow Rate (non-field based)

  • Volume Flow Rate (non-field based)

  • Area-Weighted Average

  • Mass-Weighted Average

  • Sum

  • Uniformity Index — Mass Weighted

  • Uniformity Index — Area Weighted

  • Facet Average

  • Facet Minimum

  • Facet Maximum

  • Custom Vector Based Flux (custom-vector based)

  • Custom Vector Flux (custom-vector based, non-field based)

  • Custom Vector Weighted Average (custom-vector based)

To plot or write the surface report definition data you must use a Report File or Report Plot. If a surface report definition is already included in a report file/plot, then that report file/plot will be highlighted. If you de-select a report file/plot that had included the current report definition and click OK, the report definition will be removed from that report file/plot. For additional information on report files and plots, see Report Files and Report Plots.

 Solving → Reports → Definitions → New → Surface Report

Figure 32.2:  Surface Report Definition Dialog Box

Surface Report Definition Dialog Box

The procedure for creating surface report definitions is covered in Creating Report Definitions.

32.2.1.2. Volume Report definitions

You can use the Figure 32.3: Volume Report Definition Dialog Box to create volume report definitions. There are many different types of volume reports that you can create, including:

  • Volume (non-field based)

  • Sum

  • Sum* (only axi-symmetric)

  • Max

  • Min

  • Volume Integral

  • Volume Average

  • Mass Integral

  • Mass Average

  • Mass (non-field based)

 Solving → Reports → Definitions → New → Volume Report

Figure 32.3:  Volume Report Definition Dialog Box

Volume Report Definition Dialog Box

The common steps for creating a volume report definition are covered in Creating Report Definitions, and the volume report definition-specific steps are as follows:

  1. If you want the value reported on individual wall zones rather than the net results from a group of wall zones, enable the Per Zone option.

  2. Choose the integration method for the volume report definition by selecting Volume, Sum, Sum*2Pi (2D axisymmetric cases only), Max, Min, Volume Integral, Volume-Average, Mass Integral, Mass-Average, or Mass in the Report Type drop-down list. These methods are described in Volume Integration.

  3. Specify the variable or function to be integrated in the Field Variable drop-down list. First select the desired category in the upper drop-down list. You can then select one of the related quantities in the lower list. (See Field Function Definitions for an explanation of the variables in the list.)

  4. Select the Cell Zones where you want Fluent to evaluate the specified variable.

  5. Click OK to create the report definition and close the dialog box.

32.2.1.3. Force and Moment Report definitions

Monitoring force coefficients can be useful when you are calculating external aerodynamics, for example, and are especially interested in the lift coefficient. By monitoring these values you may also be able to stop the calculation early and reduce the processing time, as sometimes the force and moment coefficients converge before the residuals have decreased three orders of magnitude. (In such an instance, you should be sure to check the mass flow rate and heat transfer rate as well, to ensure that the mass and energy are being suitably conserved. This is accomplished using either the Figure 32.5: Drag Report Definition Dialog Box, the Figure 32.6: Lift Report Definition Dialog Box, the Figure 32.7: Moment Report Definition Dialog Box, or the Figure 32.4: Force Report Definition Dialog Box).

To begin setting up force or moment report definitions, first enter appropriate values in the Reference Values task page, as described in Reference Values. The relevant values include the following:

  • The force coefficients use the reference area, density, and velocity.

  • The moment coefficients use the reference area, density, velocity and length.

For information about how these coefficients are calculated, see Computing Forces, Moments, and the Center of Pressure in the Fluent Theory Guide.


Tip:  You can have Fluent report unscaled force values by selecting Drag Force or Lift Force in the Report Output Type group box of the Drag Report Definition or Lift Report Definition dialog boxes, respectively.


Next, open the appropriate dialog box through the Solving tab of the ribbon.

 Solving → Reports → Definitions → New → Force Report

Select either Drag..., Lift..., Moment..., or Force... to open the Figure 32.5: Drag Report Definition Dialog Box, Figure 32.6: Lift Report Definition Dialog Box, Figure 32.7: Moment Report Definition Dialog Box, and Figure 32.4: Force Report Definition Dialog Box. Note that you can only access one of these report definition dialog boxes at a time, though multiple report definitions of the same type can be used during the simulation.

Figure 32.4:  Force Report Definition Dialog Box

Force Report Definition Dialog Box

Figure 32.5:  Drag Report Definition Dialog Box

Drag Report Definition Dialog Box

Figure 32.6:  Lift Report Definition Dialog Box

Lift Report Definition Dialog Box

Figure 32.7:  Moment Report Definition Dialog Box

Moment Report Definition Dialog Box

The common steps for creating a force or moment report definition are covered in Creating Report Definitions, and the force/moment report definition-specific steps are as follows:

  1. If you want to report the force or moment coefficient data from individual wall zones rather than the net results from a group of wall zones, enable the Per Zone option.

  2. Depending on the coefficient that will be monitored, perform one of the following steps:

    • In the Drag Report Definition, Lift Report Definition or Force Report Definition dialog box, enter the X, Y, and Z components of the Force Vector along which the forces will be computed. By default, the Force Vector for the drag coefficient is a unit vector in the direction, whereas for the lift coefficient it is a unit vector in the direction.

    • In the Moment Report Definition dialog box, enter the Cartesian coordinates (X, Y, and Z) of the Moment Center, about which moments will be computed. The default Moment Center is (0, 0, 0). You also need to enter the X, Y, and Z components for the Moment Axis, along which the moment coefficient will be calculated. By default, the Moment Axis is defined as a unit vector in the direction.

  3. Select the appropriate wall zone(s) for computation of the coefficient(s).

  4. You have the option to highlight a selected boundary zone and have it displayed in the graphics window by enabling Highlight Zone.

  5. Click OK to save the report definition settings.

  6. If you need to revise the settings of a particular report definition after they have been saved, double-click the report definition in the tree.

32.2.1.4. Flux Report Definition

You can use the Figure 32.8: Flux Report Definition Dialog Box to create flux report definitions. There are many different types of flux-based report definitions that you can create, including:

  • Mass Flow Rate

  • Total Heat Transfer Rate

  • Total Sensible Heat Transfer Rate

  • Radiation Heat Transfer Rate

  • Film Mass Flow Rate

  • Film Heat Transfer Rate

  • DPM Mass Source

  • DPM Enthalpy Source

  • DPM Sensible Enthalpy Source

 Solving → Reports → Definitions → New → Flux Report

Figure 32.8:  Flux Report Definition Dialog Box

Flux Report Definition Dialog Box

Figure 32.9:  DPM Source Report Definition Dialog Box

DPM Source Report Definition Dialog Box

The common steps for creating a flux report definition are covered in Creating Report Definitions, and the flux report definition-specific steps are as follows:

  1. Select or confirm the type of flux report.

  2. Select the appropriate boundaries for the flux calculations.

  3. Click OK to save the report definition settings.

  4. If you need to revise the settings of a particular report definition after they have been saved, double-click the report definition in the tree.

For additional information on the available options for DPM source report definitions, see DPM Source Report Definition in the reference guide.

32.2.1.5. DPM Report Definition

You can use the DPM Report Definition dialog box to create DPM report definitions. The following types of DPM reports are available:

  • Injected Mass (unsteady particle tracking only)

  • Mass in Domain (unsteady particle tracking only)

  • Escaped Mass

  • Evaporated Mass

  • Penetration Length (unsteady particle tracking only)

 Solving → Reports → Definitions → New → DPM Report

Figure 32.10:  DPM Report Definition Dialog Box

DPM Report Definition Dialog Box

The common steps for creating a DPM report definition are covered in Creating Report Definitions, and the DPM report definition-specific steps are as follows:

  1. Select or confirm the type of DPM report.

  2. For the Escaped Mass report, if you want to have the escaped mass calculated per injection, enable the text command report/dpm-zone-summaries-per-injection.

    The Injections selection list will then appear in the DPM Report Definition dialog box.

  3. From the Injections list, select the appropriate injections for the DPM report.


    Note:  For the Escaped Mass report, this step is relevant only if you have enabled the calculation of the escaped mass per injection.


  4. For the Escaped Mass report, select the boundary(s) where the injected particles exit the domain from the Boundaries selection list.

  5. For the Penetration Length report, you can specify the Particles Mass Fraction. You can also enable User-Specified Origin and Direction to specify those coordinates.

  6. For unsteady particle tracking, you can select Show Mass Flow/Change Rate (default) for the Injected Mass, Mass in Domain, Escaped Mass, and Evaporated Mass reports if you want to create a report for the mass flow rate rather than the total mass.

  7. Click OK to save the report definition settings.

  8. If you need to revise the settings of a particular report definition after they have been saved, double-click the report definition in the tree.


Important:  For unsteady particle tracking, if you want to select one or more injection(s) for any Escaped Mass report, you must enable the report/dpm-zone-summaries-per-injection text command before the first particles are injected; otherwise, some of the reported values may become inconsistent.


For additional information on the available options, see the DPM Report Definition Dialog Box in the reference guide.

32.2.1.6. User Defined Report Definition

User defined report definitions allow you to create functions that return values that can be plotted, printed, written, or used in other expressions. User defined report definitions can also be used in the Convergence Conditions (Convergence Conditions).

Creating a user defined report definition is a two step process:

  1. Create a user defined report definition function.

  2. Hook the user defined report definition function to the user defined report definition.

32.2.1.6.1. User Defined Report Definition Function

User defined report definition functions are defined with the DEFINE_REPORT_DEFINITION_FN macro, which takes the function name as the argument. The function must return a real value. Once written, it should be compiled and loaded the same way as other user-defined functions, see Interpreting and Compiling UDFs in the Fluent Customization Manual for more information.

The function body should be constructed similarly to any C function that returns a real value. Any valid C code can be included in the function body.

DEFINE_REPORT_DEFINITION_FN can use all of the APIs available for other user-defined functions, including:

  • Last evaluated values of all report definitions.

  • Current values of all input parameters that have been set to be used inside user-defined functions.

See DEFINE_REPORT_DEFINITION_FN in the Fluent Customization Manual for information on writing user defined report definition functions.

32.2.1.6.2. User Defined Report Definition Function Hooking

With the user defined report definition function written, you must hook this function to the user defined report definition.

The common steps for creating a user defined report definition are covered in Creating Report Definitions, and the user defined report definition-specific steps are as follows:

  1. Open the User Defined Report definition dialog box.

     Solution → Report Definitions  New → User Defined

    Figure 32.11:  User Defined Report Definition Dialog Box

    User Defined Report Definition Dialog Box

  2. Select your function from the Function drop-down list.

32.2.1.7. Expression Report Definition

You can create expressions from report definitions, allowing you to combine report definitions with mathematical operators to create a new report definition that can be written or plotted. For example, you can create a pressure-drop report for the difference in area-weighted pressures between an inlet and an outlet.

 Solving → Reports → Definitions → New → Expression

Figure 32.12:  Expression Report Definition Dialog Box

Expression Report Definition Dialog Box

The common steps for creating an expression report definition are covered in Creating Report Definitions, and the expression report definition-specific steps are as follows:

  1. Create the Report Definition(s) that you will use to create an Expression.

  2. Use the calculator buttons to add functions and operators to the expression. Select report definitions from the Report Definitions drop-down list and click Select to add them to the expression formula.

  3. Click Define to create the expression report definition.


Note:  Expression report definitions cannot be copied.



Release 18.2 - © ANSYS, Inc. All rights reserved.