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.
Document Generation
addFigure()
Add a figure to the report.

Welcome
What's New
View new features for AcuSolve 2024.1.
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
  - Report()
    Create a new LaTex file object and open it.
  - addAuthors()
    Add a set of authors to the report.
  - addBibliography()
    Add bibliography to the report.
  - addDate()
    Add date to the report.
  - addEquation()
    Add a formal equation to the report.
  - addFigure()
    Add a figure to the report.
  - addImage()
    Add an image to the report.
  - addInlineEquation()
    Add an inline equation to the report.
  - addItem()
    Add an item to a bullet or numbered block in the report.
  - addSection()
    Add a section to the report.
  - addSpace()
    Add vertical space to the report.
  - addSubSection()
    Add a sub-section to the report.
  - addSubSubSection()
    Add a sub-sub-section to the report.
  - addTable()
    Add a table to the report.
  - addTableOfContent()
    Add a table of contents to the report.
  - addText()
    Add text to the report.
  - addTitle()
    Add a title to the report.
  - beginBullet()
    Start a new bullet block in the report.
  - beginItemize()
    Start a new numbered block in the report.
  - close()
    Close the report and file.
  - convertUnit()
    Convert among physical units.
  - endBullet()
    Close a numbered block in the report.
  - endItemize()
    Close a numbered block in the report.
  - fillVSpace()
    Push text to the end of the page.
  - modifyPackageOptions()
    Modify predefined package options.
  - newPage()
    Start a new page and clear the page.
  - rawLatex()
    Adds an unformatted LaTex text to the report.
  - writeHtml()
    Convert the report to HTML format.
  - writePdf()
    Convert the report to PDF format.
  - writeRft()
    Convert the report to RTF format.
- 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)
- 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

addFigure()

Add a figure to the report.

Usage

addFigure( fileName, justify='center',
                    caption = None, scale = 1, ref = None )

Parameters

fileName (string): Figure file name. Notice that the full directory of the figure needs to be included.
justify (string): Figure justification. Valid values are flushleft, flushright and center.
caption (string): Caption of the figure.
scale (integer): Image scale.
ref (string): Label of the figure for further reference.

Return Value

None

Description

This routine adds a figure to the report. The figure fileName, justification, caption and scale are given by fileName, justify, caption and scale. The ref argument is the label of the figure for further reference. For example,

fname = vis.saveImage( width=600, height=400 )
rep.addFigure( fname, "center", "Geometry of the problem",
               1.0, "fig:geom" )
rep.addText( """The geometry is given in Figure \\ref{fig:geom}.""" )