Home
AcuReport Reference Manual
Instruction of the AcuReport tool, a standalone post-processor batch tool used to generate a report from an AcuSolve solution database.
AcuSolve Database Access (Adb)
getResRatioSteps()
Return the "Residual Ratio" steps value.

Welcome
What's New
View new features for AcuSolve 2024.
Get Started
AcuSolve is a leading general purpose CFD solver that is capable of solving the most demanding industrial and scientific applications.
Tutorials
Discover AcuSolve functionality with interactive tutorials.
AcuSolve Training Manual
Introduction of background knowledge regarding flow physics and CFD as well as detailed information about the use of AcuSolve and what specific options do.
AcuSolve Validation Manual
Collection of AcuSolve simulation cases for which results are compared against analytical or experimental results to demonstrate the accuracy of AcuSolve results.
AcuSolve Command Reference Manual
AcuSolve command descriptions and corresponding examples.
AcuSolve Programs Reference Manual
AcuSolve utility programs covering preparatory and post-processing as well as user-defined functions and utility scripts.
AcuSolve User-Defined Functions Manual
Customization of AcuSolve allowing you to customize certain capabilities of the solver.
AcuTrace Command Reference Manual
Commands of AcuTrace, a particle tracer that runs as a post-processor to or a co-processor with AcuSolve.
AcuTrace User-Defined Functions Manual
Instructions to define additional solution quantities of AcuTrace called user equations.
AcuReport Reference Manual
Instruction of the AcuReport tool, a standalone post-processor batch tool used to generate a report from an AcuSolve solution database.
- Report
  This module creates the .tex file based on the LaTex formatting system by using various methods that work on the report, such as addFigure, addSection and addTable.
- Adb
  The role of this module is to create an interface to the Acudb module for opening and extracting the last AcuSolve solution database, and transferring its data to the report and plotting them.
- 2D Plot
  This module defines the curve method for drawing an interpolated curve and the plot method that plots the curve(s) into an image file.
- 3D Plot
  The 3D plot part role is used to show and change the 3D visualization view of the problem.
- Example of .Rep File
  The .rep file may look something like the example shown below.
- Run Time Options for AcuReport
  Each program requires zero or more command-line options to run.
- Document Generation
- 2D Plot
- ReportAcs
  This module defines methods that get data from the database and adds them to the report (.tex) file and are used by the .rep file.
- AcuSolve Database Access (Adb)
  - Adb
    Create an AcuDbAssist instance.
  - get ()
    Return an Acudb value.
  - getCpuTimes()
    Return the "Run Data" CPU Time value.
  - getElapseTimes()
    Return the "Run Data" Elapsed Time value.
  - getLinIterData()
    Return the "Linear Iterations" steps, times and values data.
  - getLinIterSteps()
    Return the "Linear Iterations" steps value.
  - getLinIterTimes()
    Return the "Linear Iterations" times value.
  - getLinIterValues()
    Return the "Linear Iterations" values.
  - getLinIterVarIndx()
    Map the "Linear Iterations" variable into an index.
  - getLinIterVarNames()
    Returns a list of "Linear Iterations" variable names.
  - getOeiNameIndx()
    Map the OEI name into an index.
  - getOeiNames()
    Return the list of OEI names.
  - getOeiSteps()
    Return the list of OEI time steps.
  - getOeiTimes()
    Return OEI run times.
  - getOeiValues()
    Return the list of OEI integrated values.
  - getOeiVarNames()
    Return the list of OEI variable names.
  - getOeiVarUnit()
    Return the EI unit (default unit of unit category) of adb variable.
  - getOfcNameIndx()
    Map the OFC name into an index.
  - getOfcNames()
    Return the list of OFC names.
  - getOfcSteps()
    Return the list of OFC time steps.
  - getOfcTimes()
    Return OFC run times.
  - getOfcValues()
    Return the list of OFC integrated values.
  - getOfcVarNames()
    Return the list of OFC variable names.
  - getOfcVarUnit()
    Return the FC unit (default unit of unit category) of adb variable.
  - getOhcNameIndx()
    Map the OHC name into an index.
  - getOhcNames ()
    Return the list of OHC names.
  - getOhcSteps()
    Return the list of OHC time steps.
  - getOhcTimes()
    Return OHC run times.
  - getOhcValues()
    Return the list of OHC integrated values.
  - getOhcVarNames()
    Return the list of OHC variable names.
  - getOhcVarUnit()
    Return the HC unit (default unit of unit category) of adb variable.
  - getOqiNameIndx()
    Map the OQI name into an index.
  - getOqiNames()
    Return the list of OQI names.
  - getOqiSteps()
    Return the list of OQI time steps.
  - getOqiTimes()
    Return OQI run times.
  - getOqiValues()
    Return the list of OQI integrated values.
  - getOqiVarNames()
    Return the list of OQI variable names.
  - getOqiVarUnit()
    Return the QI unit (default unit of unit category) of adb variable.
  - getOriNameIndx()
    Map the ORI name into an index.
  - getOriNames()
    Return the list of ORI names.
  - getOriSteps()
    Return the list of ORI time steps.
  - getOriTimes()
    Return ORI run times.
  - getOriValues()
    Return the list of ORI integrated values.
  - getOriVarNames()
    Return the list of ORI variable names.
  - getOriVarUnit()
    Return the RI unit (default unit of unit category) of adb variable.
  - getOsiNameIndx()
    Map the OSI name into an index.
  - getOsiNames()
    Return the list of OSI names.
  - getOsiSteps()
    Return the list of OSI time steps.
  - getOsiTimes()
    Return OSI run times.
  - getOsiValues()
    Return the list of OSI integrated values.
  - getOsiVarNames()
    Return the list of OSI variable names.
  - getOsiVarUnit()
    Return the SI unit (default unit of unit category) of adb variable.
  - getOthNameIndx()
    Map the OTH name into an index.
  - getOthNames()
    Return the list of OTH names.
  - getOthNodes()
    Return a list of OTH nodes.
  - getOthSteps()
    Return the list of OTH time steps.
  - getOthTimes()
    Return OTH run times.
  - getOthValues()
    Return the list of OTH integrated values.
  - getOthVarNames()
    Return the list of OTH variable names.
  - getOthVarUnit()
    Return the TH unit (default unit of unit category) of adb variable.
  - getResRatioData()
    Return the "Residual Ratio" steps, times and values data.
  - getResRatioSteps()
    Return the "Residual Ratio" steps value.
  - getResRatioTimes()
    Return the "Residual Ratio" times value.
  - getResRatioValues()
    Return the "Residual Ratio" values.
  - getResRatioVarIndx()
    Map the "Residual Ratio" variable into an index.
  - getResRatioVarNames()
    Return a list of "Residual Ratio" variable names.
  - getResRatioVarUnit()
    Return the SI unit of the "Residual Ratio" variable.
  - getSolRatioData()
    Return the "Solution Ratio" steps, times and values data.
  - getSolRatioSteps()
    Return the "Solution Ratio" steps value.
  - getSolRatioTimes()
    Return the "Solution Ratio" times value.
  - getSolRatioValues()
    Return the "Solution Ratio" values.
  - getSolRatioVarIndx()
    Map the "Solution Ratio" variable into an index.
  - getSolRatioVarNames()
    Return a list of "Solution Ratio" variable names.
  - getSolRatioVarUnit()
    Return the SI unit of the "Solution Ratio" variable.
  - getSteps()
    Return the "Run Data" steps value.
  - getTimeIncs()
    Return the "Time Increment" value.
  - getTimes()
    Return the "Run Data" times value.
  - getVarUnit()
    Return the SI unit of the variable according to its adb name.
- Volume Access Functions
- Surface Access Functions
- Periodics Access Functions
- Node Access Functions
- Scalar and Vector Variables Functions
- Iso-Surface and Cut-Plane Functions
- Iso_Line Functions
- Tufts Functions
- Clip Plane Functions
- Time Step Functions
- Display Orientation Functions
- Add\Remove Actors Functions
- Set\Get Actors Properties
  Display, transparency, transparency value, color, visibility, line width and point size of the "Surface actors", "Volume Actors", "PBC Actors", "NBC Actors", "Iso-Surface Actors" and "Cut-Plane Actors" can be set through the following functions.
- Scene Graph Functions
- Miscellaneous Functions
- Basic LaTex Tags
  Below are some useful tags in the LaTex formatting system.
- Acupu Functions
AcuSolve Surface Processing

getResRatioSteps()

Return the "Residual Ratio" steps value.

Usage

resRatioSteps = adb.getResRatioSteps( var, type = 'all' )

Parameters

var (integer) or (string): The "Residual Ratio" variable name/index.
type (string): The type value; 'all', 'initial' and 'final'.

Return Value

resRatioSteps (numarray): The "Residual Ratio" step values.

Errors

var must be a valid name or index.

type must be 'all', 'initial' or 'final'.

Description

This routine returns the "Residual Ratio" steps value. The "Residual Ratio" name or index is given by var. For example,

resRatioSteps = adb.getResRatioSteps( 'velocity' )