AcuReport Reference Manual

AcuReport
Reference Manual
Version 1.8
Version 1.8
AcuReport Reference Manual
Copyright
Mailing Address: ACUSIM Software, Inc. 2685 Marine Way, Suite 1421 Mountain View, CA 94043 USA
Contact Information: Tel: FAX: Email: Web: (650) 988-9700 (650) 988-9770 sales@acusim.com www.acusim.com
Copyright 1994-2010 ACUSIM Software, Inc. All rights reserved This document, along with the software described in it, is furnished under license or a nondisclosure agreement and may be used or copied only in accordance with such terms. The information in this manual is furnished for informational use only, is subject to change without notice, and does not represent a commitment by ACUSIM Software, Inc. ACUSIM assumes no liability or responsibility for any errors that may appear in this document, or for damages resulting from the use of any information contained herein.
Version 1.8
ii
Table of Contents
Table of Contents
CHAPTER 1. 1.1 1.2 1.3 1.4 1.5 1.6 1.7 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 2 2 2 3 4 8 Report . . . . . . . . . . . . . . Adb . . . . . . . . . . . . . . . Acs . . . . . . . . . . . . . . . 2D Plot . . . . . . . . . . . . . 3D Plot . . . . . . . . . . . . . An example of .rep file . . . . . Run time opions for AcuReport
CHAPTER 2. 2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 2.9 2.10 2.11 2.12 2.13 2.14 2.15 2.16 2.17 2.18 2.19 2.20 2.21 2.22 2.23 2.24 2.25 2.26 2.27 2.28
Document Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 15 16 17 18 19 20 22 23 24 25 26 27 28 29 31 32 34 35 36 37 38 39 40 41 42 43 44
Report( ) . . . . . . . . . addAcusimLogo( ) . . . . addAuthors( ) . . . . . . . addBibliography( ) . . . . addDate( ) . . . . . . . . addEquation( ) . . . . . . addFigure( ) . . . . . . . . addImage( ) . . . . . . . . addInlineEquation( ) . . . addItem( ) . . . . . . . . . addSection( ) . . . . . . . addSpace( ) . . . . . . . . addSubSection( ) . . . . . addSubSubSection( ) . . . addTable( ) . . . . . . . . addTableOfContent( ) . . addText( ) . . . . . . . . . addTitle( ) . . . . . . . . beginBullet( ) . . . . . . . beginItemize( ) . . . . . . close( ) . . . . . . . . . . convertUnit( ) . . . . . . . endBullet( ) . . . . . . . . endItemize( ) . . . . . . . fillVSpace( ) . . . . . . . modifyPackageOptions( ) newPage( ) . . . . . . . . rawLatex( ) . . . . . . . .
Version 1.8
iii
Table of Contents
2.29 2.30 2.31
writeHtml( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 writePdf( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 writeRtf( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 2D Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
CHAPTER 3. 3.1 3.2
Curve( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Plot2D( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 AcuConsole Database Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 56 57 59 60 61 62 63 64 65 67 68 69 70 71 72 74 75 77 78 79 80 81 82 84 86 87 88 89 90
CHAPTER 4. 4.1 4.1.1 4.1.2 4.1.3 4.1.4 4.1.5 4.1.6 4.1.7 4.1.8 4.1.9 4.1.10 4.1.11 4.1.12 4.1.13 4.1.14 4.1.15 4.1.16 4.1.17 4.1.18 4.1.19 4.1.20 4.1.21 4.1.22 4.1.23 4.1.24 4.2 4.2.1 4.2.2 4.2.3 4.2.4
Acs . . . . . . . . . Acs( ) . . . . . . . . getArray( ) . . . . . . getBool( ) . . . . . . getChildNodes( ) . . getChildPars( ) . . . getColor( ) . . . . . . getDic( ) . . . . . . . getDir( ) . . . . . . . getEnum( ) . . . . . getFile( ) . . . . . . . getFileData( ) . . . . getFont( ) . . . . . . getInt( ) . . . . . . . getList( ) . . . . . . . getPar( ) . . . . . . . getPasswd( ) . . . . . getReal( ) . . . . . . getRef( ) . . . . . . . getRefs( ) . . . . . . getStr( ) . . . . . . . getTab( ) . . . . . . . getTarea( ) . . . . . . getType( ) . . . . . . getVals( ) . . . . . . ReportAcs . . . . . . ReportAcs( ) . . . . . addMaterialModel ( ) addSimpleBC( ) . . . getPrbDesc( ) . . . .
Version 1.8
iv
Table of Contents
CHAPTER 5. 5.1 5.2 5.3 5.4 5.5 5.6 5.7 5.8 5.9 5.10 5.11 5.12 5.13 5.14 5.15 5.16 5.17 5.18 5.19 5.20 5.21 5.22 5.23 5.24 5.25 5.26 5.27 5.28 5.29 5.30 5.31 5.32 5.33 5.34 5.35 5.36 5.37 5.38 5.39 5.40 5.41 5.42
AcuSolve Database Access (Adb) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 . 96 . 98 . 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
Adb( ) . . . . . . . . . get( ) . . . . . . . . . getCpuTimes( ) . . . . getElapseTimes( ) . . getLinIterData( ) . . . getLinIterSteps( ) . . . getLinIterTimes( ) . . getLinIterValues( ) . . getLinIterVarIndx( ) . getLinIterVarNames( ) getOeiNameIndx( ) . . getOeiNames( ) . . . . getOeiSteps( ) . . . . getOeiTimes( ) . . . . getOeiValues( ) . . . . getOeiVarNames( ) . . getOeiVarUnit( ) . . . getOfcNameIndx( ) . . getOfcNames( ) . . . . getOfcSteps( ) . . . . getOfcTimes( ) . . . . getOfcValues( ) . . . . getOfcVarNames( ) . . getOfcVarUnit( ) . . . getOhcNameIndx( ) . getOhcNames( ) . . . getOhcSteps( ) . . . . getOhcTimes( ) . . . . getOhcValues( ) . . . getOhcVarNames( ) . getOhcVarUnit( ) . . . getOqiNameIndx( ) . . getOqiNames( ) . . . . getOqiSteps( ) . . . . getOqiTimes( ) . . . . getOqiValues( ) . . . . getOqiVarNames( ) . . getOqiVarUnit( ) . . . getOriNameIndx( ) . . getOriNames( ) . . . . getOriSteps( ) . . . . . getOriTimes( ) . . . .
Version 1.8
Table of Contents
5.43 5.44 5.45 5.46 5.47 5.48 5.49 5.50 5.51 5.52 5.53 5.54 5.55 5.56 5.57 5.58 5.59 5.60 5.61 5.62 5.63 5.64 5.65 5.66 5.67 5.68 5.69 5.70 5.71 5.72 5.73 5.74 5.75 5.76 5.77 5.78
getOriValues( ) . . . . . getOriVarNames( ) . . . getOriVarUnit( ) . . . . getOsiNameIndx( ) . . . getOsiNames( ) . . . . . getOsiSteps( ) . . . . . . getOsiTimes( ) . . . . . getOsiValues( ) . . . . . getOsiVarNames( ) . . . getOsiVarUnit( ) . . . . getOthNameIndx( ) . . . getOthNames( ) . . . . . getOthNodes( ) . . . . . getOthSteps( ) . . . . . getOthTimes( ) . . . . . getOthValues( ) . . . . . getOthVarNames( ) . . . getOthVarUnit( ) . . . . getResRatioData( ) . . . getResRatioSteps( ) . . . getResRatioTimes( ) . . getResRatioValues( ) . . getResRatioVarIndx( ) . getResRatioVarNames( ) getResRatioVarUnit( ) . getSolRatioData( ) . . . getSolRatioSteps( ) . . . getSolRatioTimes( ) . . getSolRatioValues( ) . . getSolRatioVarIndx( ) . getSolRatioVarNames( ) getSolRatioVarUnit( ) . getSteps( ) . . . . . . . getTimeIncs( ) . . . . . getTimes( ) . . . . . . . getVarUnit( ) . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 161 162 163 164 165 166 167 169 170 171 172 173 174 175
CHAPTER 6. 6.1 6.1.1 6.2 6.2.1
3D Plot Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 178 180 181
Initialization . . . . . . . AcuVis( ) . . . . . . . . . Volume Access Functions getNVols( ) . . . . . . .
Version 1.8
vi
Table of Contents
6.2.2 6.2.3 6.3 6.3.1 6.3.2 6.3.3 6.4 6.4.1 6.4.2 6.4.3 6.5 6.5.1 6.5.2 6.5.3 6.6 6.6.1 6.6.2 6.6.3 6.6.4 6.6.5 6.6.6 6.6.7 6.6.8 6.6.9 6.6.10 6.6.11 6.7 6.7.1 6.7.2 6.7.3 6.7.4 6.7.5 6.7.6 6.7.7 6.7.8 6.7.9 6.7.10 6.8 6.8.1 6.8.2 6.8.3 6.8.4 6.8.5
getVolName( ) . . . . . . . . . . . . . getVolActor( ) . . . . . . . . . . . . . Surface Access Functions . . . . . . . getNSrfs( ) . . . . . . . . . . . . . . . getSrfName( ) . . . . . . . . . . . . . getSrfActor( ) . . . . . . . . . . . . . Periodics Access Functions . . . . . . getNPbcs( ) . . . . . . . . . . . . . . getPbcName( ) . . . . . . . . . . . . . getPbcActor( ) . . . . . . . . . . . . . Nodes Access Functions . . . . . . . . getNNbcs( ) . . . . . . . . . . . . . . getNbcName( ) . . . . . . . . . . . . . getNbcActor( ) . . . . . . . . . . . . . Scalar and Vector Variables Functions . getNVars( ) . . . . . . . . . . . . . . getVarName( ) . . . . . . . . . . . . . getVarDim( ) . . . . . . . . . . . . . . getNSclrVars( ) . . . . . . . . . . . . getSclrVarName( ) . . . . . . . . . . . getNVecVars( ) . . . . . . . . . . . . getVecVarName( ) . . . . . . . . . . . setSclVar( ) . . . . . . . . . . . . . . setSclrLimits( ) . . . . . . . . . . . . setVecVar( ) . . . . . . . . . . . . . . setVecScale( ) . . . . . . . . . . . . . Iso-surface and Cut-plane Functions . . addIsoSurface( ) . . . . . . . . . . . . getNIsos( ) . . . . . . . . . . . . . . . getIsoName( ) . . . . . . . . . . . . . getIsoActor( ) . . . . . . . . . . . . . delIsoActor( ) . . . . . . . . . . . . . addCPlane( ) . . . . . . . . . . . . . . getNCpls( ) . . . . . . . . . . . . . . . getCplName( ) . . . . . . . . . . . . . getCplActor( ) . . . . . . . . . . . . . delCplActor( ) . . . . . . . . . . . . . Iso_line functions . . . . . . . . . . . . addIsoLine( ) . . . . . . . . . . . . . . getNIsoLns( ) . . . . . . . . . . . . . getIsoLnName( ) . . . . . . . . . . . . getIsoLnActor( ) . . . . . . . . . . . . delIsoLnActor( ) . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 211 212 213 214 215 217 218 219 220 221 222 224 225 226 227
Version 1.8
vii
Table of Contents
6.9 6.9.1 6.9.2 6.10 6.10.1 6.10.2 6.10.3 6.11 6.11.1 6.11.2 6.11.3 6.11.4 6.11.5 6.12 6.12.1 6.12.2 6.12.3 6.12.4 6.12.5 6.12.6 6.12.7 6.13 6.13.1 6.13.2 6.13.3 6.13.4 6.13.5 6.13.6 6.13.7 6.13.8 6.13.9 6.13.10 6.14 6.14.1 6.14.2 6.14.3 6.14.4 6.14.5 6.14.6 6.14.7 6.15 6.15.1 6.15.2
Tufts functions . . . . . . . . . addTufts( ) . . . . . . . . . . . delTufts( ) . . . . . . . . . . . Clip Plane functions . . . . . . addClipPlane( ) . . . . . . . . delClipPlane( ) . . . . . . . . activeClipPlane( ) . . . . . . . Time step Functions . . . . . . getNSteps( ) . . . . . . . . . . getSteps( ) . . . . . . . . . . . getTimes( ) . . . . . . . . . . . setStep( ) . . . . . . . . . . . . setStepId( ) . . . . . . . . . . . Display Orientation Functions . home( ) . . . . . . . . . . . . . fit( ) . . . . . . . . . . . . . . snap( ) . . . . . . . . . . . . . snapz( ) . . . . . . . . . . . . . alignDir( ) . . . . . . . . . . . rotate( ) . . . . . . . . . . . . . zoom( ) . . . . . . . . . . . . . Add\Remove Actors Functions . addTxtActor( ) . . . . . . . . . remTxtActor( ) . . . . . . . . . addImgActor( ) . . . . . . . . remImgActor( ) . . . . . . . . addSphereActor( ) . . . . . . . delSphereActor( ) . . . . . . . addCmapLegendActor( ) . . . delCmapLegendActor( ) . . . addGeomActor( ) . . . . . . . delGeomActor( ) . . . . . . . Set\get actors properties . . . . display( ) . . . . . . . . . . . . transparency( ) . . . . . . . . . transparencyVal( ) . . . . . . . color( ) . . . . . . . . . . . . . setVisibility( ) . . . . . . . . . lineWidth( ) . . . . . . . . . . pointSize( ) . . . . . . . . . . . Scene graph Functions . . . . . saveImage( ) . . . . . . . . . . setBgColor( ) . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
228 229 231 232 233 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 254 255 257 258 260 261 263 264 268 269 270 271 272 273 275 276 277 278 279 281
Version 1.8
viii
Table of Contents
6.15.3 6.15.4 6.15.5 6.15.6 6.15.7 6.15.8 6.16 6.16.1 6.16.2 6.16.3
setAxis( ) . . . . . . . . setLineWidth( ) . . . . . setShading( ) . . . . . . setPointSize( ) . . . . . . setTransType( ) . . . . . bndBox( ) . . . . . . . . Miscellaneous Functions . setDeform( ) . . . . . . . toggleLogo( ) . . . . . . setCmap( . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . )
282 283 284 285 286 287 288 289 290 291
Exhibit A.Basic Latex Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292 Exhibit B.Acupu Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295 B.1 B.2 B.3 B.4 B.5 B.6 B.7 B.8 B.9 B.10 B.11 B.12 B.13 B.14 B.15 B.16 B.17 B.18 B.19 B.20 B.21 B.22 B.23 B.24 B.25 B.26 B.27 B.28 appendCrds( ) . . . . array2Str( ) . . . . . cksumArray( ) . . . cksumFile( ) . . . . crdOrg( ) . . . . . . cs2Str( ) . . . . . . . decryptStr( ) . . . . dupNodeMap( ) . . . elmGradField( ) . . . elmVolume( ) . . . . encryptStr( ) . . . . getCnnNodes( ) . . . getFileCnts( ) . . . . getInvMap( ) . . . . getMemoryUsage( ) getProcIds( ) . . . . getSipVoidPtrInt( ) . getSrfEdge( ) . . . . getSrfSplit( ) . . . . getVolSrf( ) . . . . . invMap( ) . . . . . . licIsAltair( ) . . . . . mapPbcFaces( ) . . . mergeCrds( ) . . . . nodalVolume( ) . . . orientSrf( ) . . . . . pyt2Str( ) . . . . . . readArrays( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 321 322 323 324 325
Version 1.8
ix
Table of Contents
B.29 B.30 B.31 B.32 B.33 B.34 B.35 B.36 B.37 B.38 B.39 B.40 B.41 B.42
readNastran( ) . . . readStl( ) . . . . . . setProgName( ) . . . srf2Tri( ) . . . . . . srfLayOut( ) . . . . srfNodalNorm( ) . . str2Array( ) . . . . . str2Cs( ) . . . . . . . str2Pyt( ) . . . . . . usrMap( ) . . . . . . volLayOut( ) . . . . writeArrays( ) . . . . writeEnsightArray( ) writeStl( ) . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
326 327 328 329 330 331 332 333 334 335 336 337 338 339
Routine Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
Version 1.8
Introduction
Report
CHAPTER 1.
Introduction
AcuReport is a standalone post-processor batch oriented tool that generates a report from an AcuSolve solution data base. It includes and uses different modules for creating this report such as Report, Adb, Acs, 2D Plot, 3D Plot, etc. Obviously, since different problems ( AcuSolve solution data base ) have very different information and structures, each report generation will be different, and each must be custom built; preferably by the end user. Hence, we will use a Python scripting for this purpose. For this, the user will write a report generator script and then every time s/he solves a new problem, s/he executes the command: acuReport -problem pump -file pump.rep -html The source (user code) for report generation will be "pump.rep", and the results will be "pump.html" plus "Figures" directory with all the images, we will also have "pump.tex" as a by product. This chapter explains the role of each module used in report generating.
1.1 Report
This module creates the tex file based on latex formatting system by using various methods that works on the report such as addFigure, addSection, and addTable. It has the ability to add raw latex texts and is able to convert the created tex file to pdf, rtf, and html using pdflatex, latex2rtf, and tth (or htlatex).
Version 1.8
Introduction
Adb
1.2 Adb
The role of this module is to create an interface to acudb module for opening and extracting the last AcuSolve solution data base, and transferring its data to the Report and Plot them. All the intermediate and final data generated by ACUSIM modules are stored in a "working directory", named ACUSIM.DIR by default. The C package "adb" (ACUSIM Data Base) may be used to extract these data through C programs, and "acudb" is a Python counterpart to "adb".
1.3 Acs
The role of this part is to create a module to facilite transferring information from Acs (AcuConsole data base file) to Report. All the intermediate data generated by AcuConsole modules are stored in an .acs file. We can read and use its data through this module.
1.4 2D Plot
This module defines the curve method for drawing an interpolated curve and the plot method which plots the curve(s) into an image file with many options available for designing the curve such as color and size. The curves shows different information and the relation between multiple values.
Version 1.8
Introduction
3D Plot
1.5 3D Plot
The 3D plot part role is to show and change 3D visualization view of the problem. The functions in this part show the problem model ( Volumes, Surfaces, Nodes, Perdiodics, etc. ). One can change the different properties of the model and scenegraph using these functions.
Version 1.8
Introduction
An example of .rep file
1.6 An example of .rep file

The .rep file may look something like the following:
#=========================================================================== # Open a document #=========================================================================== rep= Report( "pump.tex", packages=("graphicx", "hyperref") rep.modifyPackageOptions("hypersetup", optionMap={"pdfborder":"{0 0 0}"} )
#=========================================================================== # Open the model and solution #=========================================================================== acs = Acs( rep, acs ) ) )
repAcs = ReportAcs( adb = Adb(
#=========================================================================== # Set up the vis object ( 3D Plot ) #=========================================================================== vis bndBox = AcuVis( = vis.bndBox( color = (1,1,1) ) ) ) ) ) ) )
vis.setBgColor( nSrfs = vis.getNSrfs( nVols = vis.getNVols( imp = vis.getVolActor( impBbox = imp.bndBox( xmin xmax ymin ymax zmin = = = = = bndBox[0][0] bndBox[0][1] bndBox[1][0] bndBox[1][1] bndBox[1][0]
"impeller"
Version 1.8
Introduction
zmax ymid fan
= bndBox[1][1] = (impBbox[1][0] + impBbox[1][1] ) / 2 = vis.getSrfActor( "impeller" )
#=========================================================================== # Title page #=========================================================================== title = adb.get( "title" )
rep.addAcusimLogo( length = "400" ) rep.addTitle( "Pump Analysis Performed by AcuSolve\\\\" + title ) rep.addAuthors( "Joe Smith" ) rep.addText( "ACUSIM Software, Inc.", justify="center" ) rep.addDate( )# with no argument: pick up the current date rep.newPage() #=========================================================================== # Add section and a paragraph to report #=========================================================================== rep.addSection( rep.addText( "Background" """Some background information.""" ) )
#=========================================================================== # 3D Plot #=========================================================================== rep.addSubSection( "Mesh" )
for i in range(nSrfs): vis.getSrfActor(i).setVisibility('off') fan.setVisibility( 'on' fan.display( 'solid_wire' cpl.setVisibility( 'on' cpl.display( 'solid_wire' vis.home( vis.alignDir( dir = 'y-' vis.rotate( dir = "x+", angle = -45. vis.rotate( dir = "y+", angle = +45. vis.fit( fname = vis.saveImage( width = 600, height = 400
) ) ) ) ) ) ) ) ) )
rep.addFigure( fname, "center", "Geometry of the mesh", 1.0 ,
Version 1.8
Introduction
"fig:mesh"
#=========================================================================== # Reading some information from AcuConsole database #=========================================================================== rep.addSubSection( "Solver Settings" )
nodeElm = ROOT + RS +'Model'+ RS +'Volumes'+ RS +'impeller'+ RS + 'ELEMENT_SET' matName = acs.getRef( 'material_model', nodeElm ) rffName = acs.getRef( 'reference_frame', nodeElm ) nodeRff rot rotz rotz = = = = ROOT + RS + 'REFERENCE_FRAME' + RS + rffName acs.getArray( 'angular_velocity',nodeRff abs( rot[2] rep.convertUnit( rotz, "rad/sec", "RPM"
) ) )
rep.addText( repAcs.addMaterialModel( rep.addText(
"Material model is given by:\\\") matName ) "Rotational speed is %.2g" %rotz)
#=========================================================================== # 2D Plot #=========================================================================== nOsiVars= adb.get( "nOsiVars" presId= -1 massId= -1 for i in range( nOsiVars ): name= adb.get( "osiVarName", i if name == "pressure": presId = i if name == "mass_flux": massId = i nOsfs = adb.get( "nOsfs" inletId= -1 for i in range(nOsfs): name= adb.get( "osfName", if name == "inflow": inletId = i pres= adb.get( mass= adb.get( mpCurve "osiValues", "osiValues", )
inletId, inletId,
presId massId
) )
= Curve ( pres, mass, name = "Mass Flux", color = "Red" = Plot2D( mpCurve, width=600, height=400,
fname
Version 1.8
Introduction
xLabel yLabel
= "Pressure Drop (Pa)", = "Mass Flux (kg/sec)"
rep.addFigure( fname, "center", "Fan performance", 0.6,"fig:mp" ) #=========================================================================== # Close the report and make PDF #=========================================================================== rep.close( rep.writePdf( ) )
Version 1.8
Introduction
Run time opions for AcuReport
1.7 Run time opions for AcuReport

Each program requires zero or more command-line options to run. The supported command-line options for AcuReport are:
-h
Print usage and exit. It is equivalent to help = TRUE [command-line]
Default value The default value of this option is False. Example

acuReport -h
-file<str>
File name of the report generation script ; (_auto, uses <problem>.rep)
Default value The default value of this option is _auto. Example

acuReport -file pump.rep
-pb<str>
Problem name
Default value The default value of this option is _undefined. Example

acuReport -pb pump
Version 1.8
Introduction
-dir<str>
Working directory which includes all the intermediate and final data generated by ACUSIM modules
Default value The default value of this option is ACUSIM.DIR. Example

acuReport -file pump.rep -dir pump
Note : In the above example pump directory must exist and includes the data generated by ACUSIM modules.
-run<int>
Run number
Default value The default value of this option is 0 Example

acuReport -file pump.rep -run 1
-acs<str>
AcuConsole data base name; (_auto, uses <problem>.acs)
Default value The default value of this option is _auto . Example

acuReport -file pump.rep -acs pump.acs
-pdf
Create pdf file
Default value The default value of this option is False.
Version 1.8
Introduction
Example
acuReport -file pump.rep -pdf
-rtf
Create rtf file

acuReport -file pump.rep -rtf
-html
Create html file

acuReport -file pump.rep -html
-usr1<str>
User specific option 1, accessible in the report
Default value The default value of this option is None. Example

acuReport -file pump.rep -usr1 case1
-usr2<str>
User specific option 2, accessible in the report
Default value The default value of this option is None.
Version 1.8
10
Introduction
Example
acuReport -file pump.rep -usr2 case2
-v<int>
Verbose level
Default value The default value of this option is 0. Example

acuReport -file pump.rep -v 1
Version 1.8
11
Document Generation
CHAPTER 2.
Document Generation
These are the support functions documented in this chapter:

Report() addAcusimLogo() addAuthors() addBibliography() addDate() addEquation() addFigure() addImage() addInlineEquation() addItem() addSection() addSpace() addSubSection() addSubSubSection() addTable() addTableOfContent() addText() addTitle() beginBullet() beginItemize() close() convertUnit() endBullet() endItemize() fillVSpace()
Create a new LaTeX file object and open it Add the Acusim Logo to the report Add a set of authors to the report Add bibliography to the report Add date to the report Add a formal equation to the report Add a figure to the report Add an image to the report Add an inline equation to the report Add an item to a bullet or numbered block in the report Add a section to the report Add vertical space to the report Add a sub-section to the report Add a sub-sub-section to the report Add a table to the report Add table of contents to the report Add a text to the report Add title to the report Start a new bullet block in the report Start a new numbered block in the report Close the report and file Convert among physical units Close a bullet block in the report Close a numbered block in the report Push text to the end of page
12
Version 1.8
Document Generation
modifyPackageOptions() newPage() rawLatex() writeHtml() writePdf() writeRtf()
Modify predefined package options Start a new and clear page Add an unformatted latex text to the report Convert the report to HTML format Convert the report to PDF format Convert the report to RTF format
Version 1.8
13
Document Generation
Report( )
2.1 Report( )
Create a new LaTeX file object and open it.
Usage
rep = Report( fileName = None, packages = (), docClass = 'article', docClassOpt = 'psfig,12pt' )
Input Arguments
fileName File name ( .tex file name ) packages List of document packages docClass Document class docClassOpt Document class options String String List String
Return Value
repObj Report ( document ) object. Object
Description
This routine creates a new LaTeX file object and open it. For example,
rep = Report( "pump.tex", packages=("graphicx", "hyperref") )
Version 1.8
14
Document Generation
addAcusimLogo( )
2.2 addAcusimLogo( )
Add the Acusim Logo to the report.
Usage
addAcusimLogo( justify = 'center', length = 200, dir = "Figures" )
Input Arguments
justify String Logo justification. Valid values for justify are: flushleft, flushright, center length Logo length dir Image directory String Integer
Return Value
None
Description
This routine adds ACUSIM log to the report. The logo justification, length and the image directory which logo is placed are given by justify, length and dir.For example,
rep.addAcusimLogo( length = "400" )
Version 1.8
15
Document Generation
addAuthors( )
2.3 addAuthors( )
Add a set of authors to the report.
Usage
addAuthors( *args )
Input Arguments
*args Name of authors String
Return Value
None
Description
This routine adds a set of authors to the report. The authors name is given by *args.For example,
rep.addAuthors( "Joe Smith" )
Version 1.8
16
Document Generation
addBibliography( )
2.4 addBibliography( )
Add bibliography to the report.
Usage
addBibliography( title )
Input Arguments
title Biblography title which should be added String
Return Value
None
Description
This routine adds a biblography title to the report. The biblography title is given by title.For example,
rep.addBibliography( "This document is about AcuReport" )
Version 1.8
17
Document Generation
addDate( )
2.5 addDate( )
Add date to the report.
Usage
addDate( date = None )
Input Arguments
date String Date (eg., "09/17/2009"). If None the current date will be used
Return Value
None
Description
This routine adds date to the report. The date is given by date.For example,
rep.addDate( "10/24/09" )
Version 1.8
18
Document Generation
addEquation( )
2.6 addEquation( )
Add a formal equation to the report.
Usage
addEquation( equation, ref = None )
Input Arguments
equation The desired equation in latex format. ref Label of the equation for further reference String String
Return Value
None
Description
This routine adds a formal equation to the report. The equation is given by equation.The ref argument is the label of the equation for further reference. For example,
rep.addEquation( r'\rho u_{i,t} + \rho u_j u_{i,j} = -p_{,i} + \rho b_i', ref = 'eqn:continuity' ) \tau_{ij,j} +
Version 1.8
19
Document Generation
addFigure( )
2.7 addFigure( )
Add a figure to the report.
Usage
addFigure( fileName, justify='center', caption = None, scale = 1, ref = None )
Input Arguments
fileName Figure file name justify String String
Figure justification. Valid values are : flushleft, flushright, center caption Caption of the figure scale Image scale ref Label of the figure for further reference String Integer String
Return Value
None
Version 1.8
20
Document Generation
addFigure( )
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}."""
) )
Version 1.8
21
Document Generation
addImage( )
2.8 addImage( )
Add an image to the report.
Usage
addImage( fileName, justify = 'center', scale = 1, hasCaption = False )
Input Arguments
fileName Image file name justify String String
Image justification. Valid values are : flushleft, flushright, center scale Image scale hasCaption If True leave the justify block open for adding the caption Boolean Integer
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.If hasCaption is True, leaves the justify block open for adding the caption. For example,
fname = vis.saveImage( rep.addImage( width=600, height=400 fname, "center", 1.0 ) )
Version 1.8
22
Document Generation
addInlineEquation( )
2.9 addInlineEquation( )
Add an inline equation to the report.
Usage
addInlineEquation( equation )
Input Arguments
equation The equation in latex format String
Return Value
None
Description
This routine adds an inline equation to the report. The equation is given by equation.
Version 1.8
23
Document Generation
addItem( )
2.10 addItem( )
Add an item to a bullet or numbered block in the report.
Usage
addItem( text, name = None )
Input Arguments
text The item body content name The item name or title next to bullet or number String String
Return Value
None
Description
This routine adds an item to a bullet or numbered block in the report. The item text and name are given by text and name.For example,
rep.beginBullet( rep.addItem( ) )
"Sample text", "Item 1"
Version 1.8
24
Document Generation
addSection( )
2.11 addSection( )
Add a section to the report.
Usage
addSection( title )
Input Arguments
title Title of the section String
Return Value
None
Description
This routine adds a section to the report. The section title is given by title.For example,
rep.addSection( "Background" )
Version 1.8
25
Document Generation
addSpace( )
2.12 addSpace( )
Add vertical space to the report.
Usage
addSpace( spaceSize, unit = "cm" )
Input Arguments
spaceSize Space Size unit Unit of the size. Valid values are : cm, mm, in String Integer
Return Value
None
Description
This routine adds vertical space to the report. The spaceSize and unit are given by spaceSize and unit.For example,
rep.addSpace( 2, "in" )
Version 1.8
26
Document Generation
addSubSection( )
2.13 addSubSection( )
Add a sub-section to the report.
Usage
addSubSection( title )
Input Arguments
title Title of the sub-section String
Return Value
None
Description
This routine adds a sub-section to the report. The sub section title is given by title.For example,
rep.addSubSection( "Mesh" )
Version 1.8
27
Document Generation
addSubSubSection( )
2.14 addSubSubSection( )
Add a sub-sub-section to the report.
Usage
addSubSubSection( title )
Input Arguments
title Title of the sub-section String
Return Value
None
Description
This routine adds a sub-sub-section to the report. The sub-sub section title is given by title.For example,
rep.addSubSubSection( "Mesh values" )
Version 1.8
28
Document Generation
addTable( )
2.15 addTable( )
Add a table to the report.
Usage
addTable( table, caption = None, justify = None, ref = None, colsWidths = None, border = True )
Input Arguments
table List A two dimensional list containing the table rows and columns data caption Caption of the table justify String String
Table justification. Valid values are : flushleft, flushright, center ref Label of the table for reference colsWidths List of column widths in centimeter border If True draw table borders Boolean List String
Return Value
None
Version 1.8
29
Document Generation
addTable( )
Description
This routine adds a table to the report. The table contents, caption, justification, reference and columns width are given by table,caption, justify, ref and colsWidths. If border is True the table borders will be drawn. For example,
presId = -1 massId = -1 for i in range( nOsiVars ): name = adb.get( "osiVarName", i if name == "pressure": presId = i if name == "mass_flux": massId = i nOsfs = adb.get( inletId = -1 for i in range(nOsfs): name = adb.get( if name == "inflow": pres mass = adb.get( = adb.get( "nOsfs"
"osfName", i inletId = i
"osiValues", inletId, presId "osiValues", inletId, massId
) ) ) ] )
mpData= [ ("Pressure Drop (Pa)", "Mass Flux (Kg/sec)" for i in range(len(pres)): mpData.append( ("%.2f" % pres[i], "%.2f" % mass[i])
rep.addTable( mpData, "Fan performance", "center", "tab:mp" )
Version 1.8
30
Document Generation
addTableOfContent( )
2.16 addTableOfContent( )
Add table of contents to the report.
Usage
addTableOfContent( )
Input Arguments
None
Return Value
None
Description
This routine adds table of contents to the report. For example,
rep.addTableOfContent( )
Version 1.8
31
Document Generation
addText( )
2.17 addText( )
Add a text to the report.
Usage
addText( text, justify = "flushleft", style = None, size=None newLine = True, )
Input Arguments
text Text to be added to the document justify String String
Text justification.Valid values are : flushleft, flushright, center newLine If True, adds a new line after the text style String Boolean
Style of the text. Valid values are : emph, textrm, textsf, texttt, textup, textit, textsl, textsc, textbf, textmd, uline, uwave, sout size String
Text size. Valid values are : HUGE, Huge, LARGE, Large, large, small, tiny
Return Value
None
Version 1.8
32
Document Generation
addText( )
Description
This routine adds a text to the report. The text contents, justification, style and size are given by text, justify, style and size. If newLine is True a new line will be added after the text. For example,
rep.addText( "ACUSIM Software, Inc.", justify="center" )
Version 1.8
33
Document Generation
addTitle( )
2.18 addTitle( )
Add title to the report.
Usage
addTitle( title )
Input Arguments
title Title of the document String
Return Value
None
Description
This routine adds title to the report. For example,
title = adb.get( "title" rep.addTitle("Pump Analysis Performed by AcuSolve\\\\" + title ) )
Version 1.8
34
Document Generation
beginBullet( )
2.19 beginBullet( )
Start a new bullet block in the report.
Usage
beginBullet( )
Input Arguments
None
Return Value
None
Description
This routine starts a new bullet block in the report. For example,
rep.beginBullet( )
Version 1.8
35
Document Generation
beginItemize( )
2.20 beginItemize( )
Start a new numbered block in the report.
Usage
beginItemize( indexType = "" )
Input Arguments
indexType String Type of index. Valid values are : arabic, alph, Alph, roman, Roman, fnsymbol
Return Value
None
Description
This routine starts a new numbered block in the report. The index type is given by indexType.For example,
rep.beginItemize( "roman" )
Version 1.8
36
Document Generation
close( )
2.21 close( )
Close the report and file.
Usage
close( )
Input Arguments
None
Return Value
None
Description
This routine closes the report and file.For example,
rep.close( )
Version 1.8
37
Document Generation
convertUnit( )
2.22 convertUnit( )
Convert among physical units.
Usage
newValue = convertUnit( quantity, fromUnit, toUnit )
Input Arguments
quantity Physical quantity fromUnit Source unit toUnit Destination unit String String Real
Return Value
newValue The converted value Real
Description
This routine converts a physical quantity from fromUnit to toUnit.For example,
nodeElm = ROOT + RS +'Model'+ RS +'Volumes'+ RS +'impeller' + RS + 'ELEMENT_SET' rffName = acs.getRef( 'reference_frame', nodeElm ) nodeRff = ROOT + RS + 'REFERENCE_FRAME' + RS + rffName rot rotz rotz = acs.getArray( 'angular_velocity', nodeRff = abs( rot[2] = rep.convertUnit( rotz, "rad/sec", "RPM" ) ) )
Version 1.8
38
Document Generation
endBullet( )
2.23 endBullet( )
Close a numbered block in the report.
Usage
endBullet( )
Input Arguments
None
Return Value
None
Description
This routine closes a bullet block in the report.For example,
rep.endBullet( )
Version 1.8
39
Document Generation
endItemize( )
2.24 endItemize( )
Close a numbered block in the report.
Usage
endItemize( )
Input Arguments
None
Return Value
None
Description
This routine closes a numbered block in the report.For example,
rep.endItemize( )
Version 1.8
40
Document Generation
fillVSpace( )
2.25 fillVSpace( )
Push text to the end of page.
Usage
fillVSpace( )
Input Arguments
None
Return Value
None
Description
This routine pushes text to the end of page.For example,
rep.fillVSpace( )
Version 1.8
41
Document Generation
modifyPackageOptions( )
2.26 modifyPackageOptions( )
Modify predefined package options.
Usage
modifyPackageOptions( package, optionMap )
Input Arguments
package Package name (e.g., "hypersetup") optionMap Key-value pairs of options Dictionary String
Return Value
None
Description
This routine modifies predefined package options. For example,
rep.modifyPackageOptions( "hypersetup", optionMap={"pdfborder":"{0 0 0}"} )
Version 1.8
42
Document Generation
newPage( )
2.27 newPage( )
Start a new and clear page.
Usage
newPage( )
Input Arguments
None
Return Value
None
Description
This routine start a new and clear page. For example,
rep.newPage( )
Version 1.8
43
Document Generation
rawLatex( )
2.28 rawLatex( )
Adds an unformatted latex text to the report.
Usage
rawLaTeX( text )
Input Arguments
text The unformatted latex text which should be added String
Return Value
None
Description
This routine adds an unformatted latex text to the report. This text is given by text.
Version 1.8
44
Document Generation
writeHtml( )
2.29 writeHtml( )
Convert the report to HTML format.
Usage
writeHtml( converter = "tth", credit = False )
Input Arguments
converter Specifies the converter. Valid values are: tth, htlatex credit Boolean String
Specifies whether tth credit should be exist in html output or not
Return Value
None
Description
This routine converts the report to HTML format. The converter is given by converter. For example,
rep.writeHtml( )
Version 1.8
45
Document Generation
writePdf( )
2.30 writePdf( )
Convert the report to PDF format.
Usage
writePdf( )
Input Arguments
None
Return Value
None
Description
This routine converts the report to PDF format. For example,
rep.writePdf( )
Version 1.8
46
Document Generation
writeRtf( )
2.31 writeRtf( )
Convert the report to RTF format.
Usage
writeRtf( )
Input Arguments
None
Return Value
None
Description
This routine converts the report to RTF format. For example,
rep.writeRtf( )
Note that latex2rtf does not create the table of contents automatically. You need to open the outputted rtf file with a word processor such as office word and select all the document (ctrl+A) and then press F9 (refresh) to populate the table.
Version 1.8
47
2D Plot
CHAPTER 3.
2D Plot

Curve() Plot2D()
Create a curve with the styles provided Create an x-y plot from a set of curve
Version 1.8
48
2D Plot
Curve( )
3.1 Curve( )
Creates a curve with the styles provided.
Usage
curve = Curve( x, name = None, lineWidth = 1, symbolSize= 1, y, lineType = "solid", symbol = None, color = "blue"
Input Arguments
x The value of the X data of the curve y The value of the Y data of the curve name The curve's name lineType String String Array Array
The curve's line types. Valid values are : solid(-), dashed(--), dash-dot(-.), dotted(:) lineWidth The curve's line width symbol String Integer
The curve's symbol. Valid values are : points(.), pixels(,), circle(o), triangleUp(^), triangleDown(v), triangleLeft(<), triangleRight(>), square(s), plus(+), cross(x), diamond(D), thinDiamond(d), tripodDown(1), tripodUp(2), tripodLeft(3), tripodRight(4), hexagon(h), rotatedHexagon(H), pentagon(p), verticalLine( | ), horizontalLine( _ ) symbolSize The curve's symbol size Integer
Version 1.8
49
2D Plot
Curve( )
color
String
The curve's color string. Valid values are : blue(b), green(g), red(r), cyan(c), magenta(m), yellow(y), black(k), white(w)
Return Value
curve The created curve information Dictionary
Description
This routine creates a curve with the styles provided. The curve x and y data are given by x and y . The curve name, line type, line width, symbol, symbol size and color are given by name, lineType, lineWidth, symbol, symbolSize and color respectively. For example,
nOsiVars = adb.get( "nOsiVars" presId = -1 massId = -1 for i in range( nOsiVars ): name = adb.get( "osiVarName", if name == "pressure": presId = i if name == "mass_flux": massId = i nOsfs = adb.get( "nOsfs" inletId = -1 for i in range(nOsfs): name = adb.get( "osfName", if name == "inflow": inletId = i pres mass mpCurve = adb.get( = adb.get( = Curve ( )
"osiValues", inletId, presId ) "osiValues", inletId, massId ) pres, mass, name = "Mass Flux", color = "Red"
Version 1.8
50
2D Plot
Plot2D( )
3.2 Plot2D( )
Creates an x-y plot from a set of curves.
Usage
fileName = Plot2D( curves, legend xLabel xRange yLog width fileName dirName = = = = = = = True, "X", "auto", False, 600, None, None title legendPos xLog yLabel yRange height fileType = = = = = = = "", "auto", False, "Y", "auto", 400, "png", )
Input Arguments
curves List of lists, each child list is a curve title Plot title legend If True, creates a legend for the lines in the plot. legendPos String Boolean String List
Legend position in the plot. Valid values are : auto, best(0), upper right (1), upper left(2), lower left(3), lower right(4), right(5), center left(6), center right(7), lower center(8), upper center(9), center (10) xLabel The X-axis label xLog The X-axis scale Linear/Log. If True, the scale will be Log. Boolean String
Version 1.8
51
2D Plot
Plot2D( )
xRange
String or List
The X value range. Valid values are : auto, [min,max] where min/max are float numbers yLabel The Y-axis label yLog The Y-axis scale Linear/Log. If True, the scale will be Log. yRange String or List Boolean String
The Y value range. Valid values are : auto, [min,max] where min/max are float numbers width Plot width height Plot height fileName The name of file to be saved fileType Type of the image file to be saved dirName Directory of output file String String String Integer Integer
Return Value
fileName Name of the saved file String
Description
This routine creates an x-y plot from a set of curves. The curves data is given by curves. The plot tilte, xLabel, yLabel, width, height, xRange and yRange are given by title, xLabel, yLabel, width, height, xRange and yRange respectively. If legend is True, a legend will be created for the lines in the plot. The
Version 1.8
52
2D Plot
Plot2D( )
legend position is given by legendPos. The plot will be saved in a file. The file name, file type and directoy name which the image will be placed in are given by fileName, fileType and dirName. For example,
fname = Plot2D( mpCurve, width=600, height=400, xLabel = "Pressure Drop (Pa)", yLabel = "Mass Flux (kg/sec)"
Where mpCurve is returned from the Curve function we had as an example in Curve section.
Version 1.8
53
AcuConsole Database access functions
CHAPTER 4.
AcuConsole Database Access
Version 1.8
54
Acs
4.1
Acs

Acs() getArray() getBool() getChildNodes() getChildPars() getColor() getDic() getDir() getEnum() getFile() getFileData() getFont() getInt() getList() getPar() getPasswd() getReal() getRef() getRefs() getStr() getTab() getTarea() getType() getVals()
Load an Acs database file Get an array par value from database Get a bool par value from database Get a list of child nodes Get a list of child pars Get a color par value from database Get a dictionary par value from database Get a directory par value from database Get an enum par value from database Get a file par value from database The content of the par is put in the file, and the name of the file is returned Get a font par value from database Get an integer par value rom database Get a list par value from database Get a par value from database Get a password par value from database Get a real par value from database Get a ref par value from database Get a refs par value from database Get a string par value from database Get a tab par value from database Get a Tarea par value from database Get the type of the par Get a par values from database
Version 1.8
55
Acs( )
4.1.1 Acs( )
Load an Acs database file
Usage
acs = Acs( fileName = None )
Input Arguments
fileName Acs database file name String
Return Value
acs A DB instance Database object
Description
This routine loads an Acs database file. The database file name is given by fileName .For example,
acs = Acs()
Version 1.8
56
getArray( )
4.1.2 getArray( )
Get an array par value from database.
Usage
aryVal = acs.getArray( par, path )
Input Arguments
par The parameter name. path Data base path of the par. String String
Return Value
aryVal The parameter value. Array
Errors

The path should be valid. The parameter in the data base must be an Array.
Description
This routine returns an array parameter from the data base. The parameter address is given by its node path and the par name. For example,
nodeElm = ROOT + RS +'Model'+ RS +'Volumes'+ RS +'impeller' + RS + 'ELEMENT_SET' rffName = acs.getRef( 'reference_frame', nodeElm )
Version 1.8
57
getArray( )
nodeRff = ROOT + RS + 'REFERENCE_FRAME' + RS + rffName rot = acs.getArray( 'angular_velocity', nodeRff
Version 1.8
58
getBool( )
4.1.3 getBool( )
Get a bool par value from database.
Usage
boolVal = acs.getBool( par, path )
Input Arguments
Return Value
boolVal The parameter value. Boolean
Errors

The path should be valid. The parameter in the data base must be a Boolean value.
Description
This routine returns a boolean parameter from the data base. The parameter address is given by its node path and the par name. For example,
nodeEqn ext = ROOT + RS + 'EQUATION' = acs.getBool( par = 'external_code', path = nodeEqn )
Version 1.8
59
getChildNodes( )
4.1.4 getChildNodes( )
Get a list of child nodes.
Usage
childNodes = acs.getChildNodes( path )
Input Arguments
path Data base path of the node. String
Return Value
childNodes The childs of the node. List
Errors
The path should be valid.
Description
This routine returns a list of the node children. The node address is given by path. For example,
nodeMat parts = ROOT + RS + 'MATERIAL_MODEL' = acs.getChildNodes( nodeMat )
Version 1.8
60
getChildPars( )
4.1.5 getChildPars( )
Get a list of child pars.
Usage
childPars = acs.getChildPars( path )
Input Arguments
path Data base path of the node. String
Return Value
childPars List of child pars. List
Errors
The path should be valid.
Description
This routine returns a list of the node parameters. The node address is given by path. For example,
nodeMat pars = ROOT + RS + 'MATERIAL_MODEL' = acs.getChildPars( nodeMat )
Version 1.8
61
getColor( )
4.1.6 getColor( )
Get a color par value from database.
Usage
clrVal = acs.getColor( par, path )
Input Arguments
Return Value
clrVal The parameter value. List( of RGB values )
Errors

The path should be valid. The parameter in the data base must be a List.
Description
This routine returns a color parameter from the data base. The parameter address is given by its node path and the par name. For example,
nodeEqn = ROOT + RS + 'EQUATION' MeshColor= acs.getColor( par = 'mesh_color', path = nodeEqn )
Version 1.8
62
getDic( )
4.1.7 getDic( )
Get a dictionary par value from database.
Usage
dicVal = acs.getDic( par, path )
Input Arguments
Return Value
dicVal The parameter value. Dictionary
Errors

The path should be valid. The parameter in the data base must be a Dictionary.
Description
This routine returns a dictionary parameter from the data base. The parameter address is given by its node path and the par name. For example,
nodeCad = ROOT + RS + 'main' + RS + 'CAD_DATA' oldGeomModel = getDic( par = 'regGeomModel', path = nodeCad )
Version 1.8
63
getDir( )
4.1.8 getDir( )
Get a directory par value from database.
Usage
dirVal = acs.getDir( par, path )
Input Arguments
Return Value
dirVal The parameter value. String( Path of a directory )
Errors

The path should be valid. The parameter in the data base must be a String value.
Description
This routine returns a directory parameter from the data base. The parameter address is given by its node path and the par name. For example,
nodeEqn meshDir = ROOT + RS + 'EQUATION' = acs.getDir( par = 'mesh_dir', path = nodeEqn )
Version 1.8
64
getEnum( )
4.1.9 getEnum( )
Get an enum par value from database.
Usage
enumVal = acs.getEnum( par, path )
Input Arguments
Return Value
enumVal The parameter value. Enum
Errors

The path should be valid. The parameter in the data base must be an Enum value.
Description
This routine returns an enum parameter from the data base. The parameter address is given by its node path and the par name. For example,
modelSrf nodeCbc = ROOT + RS + "Model" + RS + "Surfaces" = modelSrf + RS + name + RS + 'SIMPLE_BOUNDARY_CONDITION'
Version 1.8
65
getEnum( )
type
= acs.getEnum(
"type",
nodeCbc
Version 1.8
66
getFile( )
4.1.10 getFile( )
Get a file par value from database.
Usage
fileVal = acs.getFile( par, path )
Input Arguments
Return Value
fielVal The parameter value. String( file path )
Errors

Description
This routine returns a file parameter from the data base. The parameter address is given by its node path and the par name. For example,
nodeEqn inpFile = ROOT + RS + 'EQUATION' = acs.getFile( par = 'inp_file', path = nodeEqn )
Version 1.8
67
getFileData( )
4.1.11 getFileData( )
The content of the par is put in the file, and the name of the file is returned:.
Usage
fileDataVal = acs.getFileData( par, path )
Input Arguments
Return Value
fielDataVal The parameter value. String
Errors

Description
This routine puts the content of the par in the file, and the name of the file is returned. The parameter address is given by its node path and the par name. For example,
nodeEqn inpFileData = ROOT + RS + 'EQUATION' = acs.getFileData( par = 'inp_file_data', path = nodeEqn )
Version 1.8
68
getFont( )
4.1.12 getFont( )
Get a font par value from database.
Usage
fontVal = acs.getFont( par, path )
Input Arguments
Return Value
fontVal The parameter value. String( font name and size )
Errors

The path should be valid. The parameter in the data base must be a Boolean value.
Description
This routine returns a font parameter from the data base. The parameter address is given by its node path and the par name. For example,
nodeEqn font = ROOT + RS + 'EQUATION' = acs.getFont( par = 'font', path = nodeEqn )
Version 1.8
69
getInt( )
4.1.13 getInt( )
Get an integer par value from database.
Usage
intVal = acs.getInt( par, path )
Input Arguments
Return Value
intVal The parameter value. Integer
Errors

The path should be valid. The parameter in the data base must be an Integer value.
Description
This routine returns an integer parameter from the data base. The parameter address is given by its node path and the par name. For example,
nodeEqn nSpecs = ROOT + RS + 'EQUATION' = acs.getInt( path = nodeEqn, par = 'num_species' )
Version 1.8
70
getList( )
4.1.14 getList( )
Get a list par value from database.
Usage
listVal = acs.getList( par, path )
Input Arguments
Return Value
listVal The parameter value. List
Errors

The path should be valid. The parameter in the data base must be a List.
Description
This routine returns a list parameter from the data base. The parameter address is given by its node path and the par name. For example,
nodeMdl = ROOT + RS + 'Model' meshSets = acs.getList( path = nodeMdl, par = 'meshSets' )
Version 1.8
71
getPar( )
4.1.15 getPar( )
Get a par value from database.
Usage
parVal = acs.getPar( name, path, parType = pnlDb.BOOL )
Input Arguments
name The parameter name. path Data base path of the par. parType Type( INT, BOOL, REAL...) String String
Parameter type.It could be INT, BOOL, REAL, STR, ENUM, REF, TAB, TAREA, LIST, REFS, ARY, FDATA, FILE, DIR, PASSWD, FONT or COLOR ...
Return Value
parVal The parameter value. Depends on parType(int,str,..)
Errors

The path should be valid. The type of the parameter in the data base must be in accordance with the parType.
Version 1.8
72
getPar( )
Description
This routine returns a parameter value from the data base. The parameter address is given by its node path and the par name. The parameter type is given by parType.For example,
nodeCrd = ROOT + RS + 'Mesh' + RS + 'Coordinate' usrIds = acs.getPar( name = "usrIds", path = nodeCrd, ARRAY )
Version 1.8
73
getPasswd( )
4.1.16 getPasswd( )
Get a password par value from database.
Usage
passwdVal = acs.getPasswd( par, path )
Input Arguments
Return Value
passwdVal The parameter value. String
Errors

The path should be valid. The parameter in the data base must be a String.
Description
This routine returns a password parameter from the data base. The parameter address is given by its node path and the par name. For example,
nodeMdl = ROOT + RS + 'Model' password = acs.getPasswd( path = nodeMdl, par = 'password' )
Version 1.8
74
getReal( )
4.1.17 getReal( )
Get a real par value from database.
Usage
realVal = acs.getReal( par, path, unit = None )
Input Arguments
par The parameter name. path Data base path of the par. unit String String String
Returned unit. If this parameter is not None, the return value is converted into this unit.
Return Value
realVal The parameter value. Real
Errors

The path should be valid. The parameter in the data base must be a Real value.
Description
This routine returns a real parameter from the data base. The parameter address is given by its node path and the par name. For example,
Version 1.8
75
getReal( )
path node x0
= nodePev + RS + 'contact_conditions' = path + RS + 'row' = getReal( 'pointX', node
Version 1.8
76
getRef( )
4.1.18 getRef( )
Get a ref par value from database.
Usage
refVal = acs.getRef( par, path )
Input Arguments
Return Value
refVal The parameter value. String
Errors

Description
This routine returns a ref parameter from the data base. The parameter address is given by its node path and the par name. For example,
nodeElm = ROOT + RS +'Model'+ RS +'Volumes'+ RS +'impeller' + RS + 'ELEMENT_SET' matName = acs.getRef( 'material_model', nodeElm )
Version 1.8
77
getRefs( )
4.1.19 getRefs( )
Get a refs par value from database.
Usage
refsVal = acs.getRefs( par, path )
Input Arguments
Return Value
refsVal The parameter value. List of strings
Errors

The path should be valid. The parameter in the data base must be a List of strings.
Description
This routine returns a refs parameter from the data base. The parameter address is given by its node path and the par name. For example,
nodeStg = ROOT + RS + 'STAGGER' staggers = acs.getRefs( par = 'staggers', path = nodeStg )
Version 1.8
78
getStr( )
4.1.20 getStr( )
Get a string par value from database.
Usage
strVal = acs.getStr( par, path )
Input Arguments
Return Value
strVal The parameter value. String
Errors

Description
This routine returns a string parameter from the data base. The parameter address is given by its node path and the par name. For example,
nodeGlbMshAtt = ROOT + RS + 'GLOBAL_MESH_ATTRIBUTES' smootCrt = acs.getStr( par = 'SmoothCriteria', path = nodeGlbMshAtt )
Version 1.8
79
getTab( )
4.1.21 getTab( )
Get a tab par value from database.
Usage
tabVal = acs.getTab( par, path )
Input Arguments
Return Value
tabVal The parameter value. String
Errors

The path should be valid. The parameter in the data base must be one of the defined Tab names .
Description
This routine returns a tab parameter from the data base. The parameter address is given by its node path and the par name. For example,
nodeBfs tab = ROOT + RS + 'BODY_FORCE' = acs.getTab( par = 'tab', path = nodeBfs )
Version 1.8
80
getTarea( )
4.1.22 getTarea( )
Get a tarea par value from database.
Usage
tareaVal = acs.getTarea( par, path )
Input Arguments
Return Value
tareaVal The parameter value. String
Errors

Description
This routine returns a tarea parameter from the data base. The parameter address is given by its node path and the par name. For example,
nodeNic = ROOT + RS + 'NODAL_INITIAL_CONDITION' funcX = acs.getTarea( par = "script", path = nodeNic + RS + 'x_velocity' )
Version 1.8
81
getType( )
4.1.23 getType( )
Get the type of the par from the data base.
Usage
parType = acs.getType( par, path )
Input Arguments
Return Value
parType The parameter type. Type(int,str,...)
Errors

The parameter in the data base must be of a valid type . The parameter must exist in the data base .
Description
This routine returns type of the parameter from the data base. The parameter address is given by its node path
and the par name. Return type can be integer, string, enumeration, list, bool, ref, refs,array, real, tab etc. For example,
Version 1.8
82
getType( )
nodeNic = ROOT + RS + 'NODAL_INITIAL_CONDITION' parType = acs.getType( par = "script", path = nodeNic )
Version 1.8
83
getVals( )
4.1.24 getVals( )
Get a par values from the data base.
Usage
parVals = acs.getVals( par, path, parType = pnlDb.BOOL )
Input Arguments
par The parameter name. path Data base path of the par. parType Type( INT, BOOL, REAL...) String String
Parameter type.It could be INT, BOOL, REAL, STR, ENUM, REF, TAB, TAREA, LIST, REFS, ARY, FDATA, FILE, DIR, PASSWD, FONT or COLOR ...
Return Value
parVals The parameter type. Dictionary
Errors

The parameter in the data base must be of a valid type . The parameter must exist in the data base .
Version 1.8
84
getVals( )
Description
This routine returns values of the parameter from the data base. The parameter address is given by its node path
and the par name. For example,
nodeNic = ROOT + RS + 'NODAL_INITIAL_CONDITION' parVals = acs.getVals( par = "script", path = nodeNic )
Version 1.8
85
ReportAcs
4.2
ReportAcs
This module defines methods that get data from database and add them to the report (tex) file and are used by .rep file. These are the support functions documented in this chapter:
RepAcs() addMaterialModel() addSimpleBC() getPrbDesc()
Load an Acs database file Write out the material model data in the report document Writes out the simple boundary condition data in the report document Get the problem description and equations
Version 1.8
86
ReportAcs( )
4.2.1 ReportAcs( )
Create a RepAcs instance.
Usage
repAcs = ReportAcs( report = None, acs = None )
Input Arguments
report Report object. acs Database object Object Object
Return Value
repAcs ReportAcs object. Object
Errors
The report and database objects must be created before.
Description
This routine creates a RepAcs instance. For example,
rep = Report( "pump.tex", packages=("graphicx", "hyperref") ) acs = Acs( ) repAcs = ReportAcs( rep, acs )
Version 1.8
87
addMaterialModel ( )
4.2.2 addMaterialModel ( )
Write out the material model data in the report document.
Usage
repAcs.addMaterialModel( name )
Input Arguments
name String The material model name.Valid values are : Air, Aluminum, Water
Return Value
None
Errors
The name should be valid.
Description
This routine writes out the material model data in the report document. The material model name that its data should be written is given by name.For example,
nodeElm = ROOT + RS +'Model'+ RS +'Volumes'+ RS +'impeller' + RS + 'ELEMENT_SET' matName = acs.getRef( 'material_model', nodeElm ) repAcs.addMaterialModel( matName )
Version 1.8
88
addSimpleBC( )
4.2.3 addSimpleBC( )
Writes out the simple boundary condition data in the report document.
Usage
repAcs.addSimpleBC( name )
Input Arguments
name The simple BC model name. String
Return Value
None
Errors
The name should be valid.
Description
This routine writes out the simple boundary condition data in the report document. The model name that its data should be written is given by name. For example,
repAcs.addMaterialModel( wall )
Version 1.8
89
getPrbDesc( )
4.2.4 getPrbDesc( )
Get the problem description and equations.
Usage
prbData = repAcs.getPrbDesc( )
Input Arguments
None
Return Value
prbData List Problem description info which is ( mode, flow, temp, rad, spec, nSpecs, turb, mesh, ext )
Errors
None
Description
This routine get the problem description and equations. For example,
(mode,flow,temp,rad,spec,nSpecs,turb,mesh,ext) = repAcs.getPrbDesc( )
Version 1.8
90
AcuSolve Database Access
CHAPTER 5.
AcuSolve Database Access (Adb)
Adb() get() getCpuTimes() getElapseTimes() getLinIterData() getLinIterSteps() getLinIterTimes() getLinIterValues() getLinIterVarIndx() getLinIterVarNames() getOeiNameIndx() getOeiNames() getOeiSteps() getOeiTimes() getOeiValues() getOeiVarNames() getOeiVarUnit() getOfcNameIndx() getOfcNames()
Create a AcuDbAssist instance Return an acudb value Return the "Run Data" CPU Time value Return the "Run Data" Elapsed Time value Return the "Linear Iterations" steps, times and values data Return the "Linear Iterations" steps value Return the "Linear Iterations" times value Return the related "Linear Iterations" values Map the "Linear Iterations" variable into an index Return a list of "Linear Iterations" variable names Map the OEI name into an index Return the list of OEI names Return the list of OEI time steps Return OEI run times Return the list of OEI integrated values Return the list of OEI variable names Return the EI unit of adb variable Map the OFC name into an index Return the list of OFC names
Version 1.8
91
getOfcSteps() getOfcTimes() getOfcValues() getOfcVarNames() getOfcVarUnit() getOhcNameIndx() getOhcNames() getOhcSteps() getOhcTimes() getOhcValues() getOhcVarNames() getOhcVarUnit() getOqiNameIndx() getOqiNames() getOqiSteps() getOqiTimes() getOqiValues() getOqiVarNames() getOqiVarUnit() getOriNameIndx() getOriNames() getOriSteps() getOriTimes() getOriValues() getOriVarNames() getOriVarUnit() getOsiNameIndx() getOsiNames() getOsiSteps() getOsiTimes() getOsiValues() getOsiVarNames()
Return the list of OFC time steps Return OFC run times Return the list of OFC integrated values Return the list of OFC variable names Return the FC unit of adb variable Map the OHC name into an index Return the list of OHC names Return the list of OHC time steps Return OHC run times Return the list of OHC integrated values Return the list of OHC variable names Return the HC unit of adb variable Map the OQI name into an index Return the list of OQI names Return the list of OQI time steps Return OQI run times Return the list of OQI integrated values Return the list of OQI variable names Return the QI unit of adb variable Map the ORI name into an index Return the list of ORI names Return the list of ORI time steps Return ORI run times Return the list of ORI integrated values Return the list of ORI variable names Return the RI unit of adb variable Map the OSI name into an index Return the list of OSI names Return the list of OSI time steps Return OSI run times Return the list of OSI integrated values Return the list of OSI variable names
Version 1.8
92
getOsiVarUnit() getOthNameIndx() getOthNames() getOthNodes() getOthSteps() getOthTimes() getOthValues() getOthVarNames() getOthVarUnit() getResRatioData() getResRatioSteps() getResRatioTimes() getResRatioValues() getResRatioVarIndx() getResRatioVarNames() getResRatioVarUnit() getSolRatioData() getSolRatioSteps() getSolRatioTimes() getSolRatioValues() getSolRatioVarIndx() getSolRatioVarNames() getSolRatioVarUnit() getSteps() getTimeIncs() getTimes() getVarUnit()
Return the SI unit of adb variable Map the OTH name into an index Return the list of OTH names Return a list of OTH nodes Return the list of OTH time steps Return OTH run times Return the list of OTH integrated values Return the list of OTH variable names Return the TH unit of adb variable Return the "Residual Ratio" steps, times and values data Return the "Residual Ratio" steps value Return the "Residual Ratio" times value Return the related "Residual Ratio" values Map the "Residual Ratio" variable into an index Return a list of "Residual Ratio" variable names Returns the SI unit of the "Residual Ratio" variable Return the "Solution Ratio" steps, times and values data Return the "Solution Ratio" steps value Return the "Solution Ratio" times value Return the related "Solution Ratio" values Map the "Solution Ratio" variable into an index Return a list of "Solution Ratio" variable names Returns the SI unit of the "Solution Ratio" variable Return the adb steps value Return the "Time Increment" value Return the adb times value Return the SI unit of the variable according to its adb name
Version 1.8
93
Adb( )
5.1 Adb( )
Create an AcuDbAssist instance
Usage
adb = Adb( problemName = None, dirName = None, runId = None )
Input Arguments
problemName Name of the problem dirName Name of the working directory runId Run number Integer String String
Return Value
None
Errors
Working directory must exist and have the required information.
Description
This routine creates an AcuDbAssist instance which is an interface to acudb module for opening and extracting the last AcuSolve solution data base, and transferring its data to the Report and Plot them. The adb problem is given by problemName and the working directory which includes the information of adb is given by dirName. For example,
Version 1.8
94
Adb( )
adb
= Adb(
problemName = "pump", dirName = "ACUSIM.DIR", runId = 1
Version 1.8
95
get( )
5.2 get( )
Return an acudb value
Usage
value = adb.get( name, index2 = None, index1 = None, index3 = None )
Input Arguments
name Name of the data index1 Index 1 of the data index2 Index 2 of the data index3 Index 3 of the data Integer Integer Integer String
Return Value
value Acudb value Depend on the variable
Errors
Index1,2,3 must have proper values.
Version 1.8
96
get( )
Description
This routine returns an acudb value. The adb variable name is given by name. For example,
OsiVars = adb.get( for i in range( nOsiVars ): name = adb.get( "nOsiVars" "osiVarName", i ) )
Version 1.8
97
getCpuTimes( )
5.3 getCpuTimes( )
Return the "Run Data" CPU Time value
Usage
cputimes = adb.getCpuTimes( )
Input Arguments
None
Return Value
cpuTimes List of CPU Time values Array( Numarray )
Errors
None
Description
This routine returns the Run data CPU Times values. For example,
cpuTimes = adb.getCpuTimes( )
Version 1.8
98
getElapseTimes( )
5.4 getElapseTimes( )
Return the "Run Data" Elapsed Time value
Usage
elpstimes = adb.getElapseTimes( )
Input Arguments
None
Return Value
elpsTimes List of Elapsed Time values Array( Numarray )
Errors
None
Description
This routine returns the Run data Elapsed Times values. For example,
elpsTimes = adb.getElapseTimes( )
Version 1.8
99
getLinIterData( )
5.5 getLinIterData( )
Return the "Linear Iterations" steps, times and values data
Usage
linIterData = adb.getLinIterData( var, index = 0 )
Input Arguments
var The "Linear Iterations" variable name/index index The index of nIters Integer String or integer
Return Value
linIterData Tuple The "Linear Iterations" data including steps,times and values
Errors

var must be a valid name or index. Index must have proper value.
Description
This routine returns the "Linear Iterations" steps, times and values data. The variable name or index is given by var. For example,
linData = adb.getLinIterData( 1,2 )
Version 1.8
100
getLinIterSteps( )
5.6 getLinIterSteps( )
Return the "Linear Iterations" steps value
Usage
linIterSteps = adb.getLinIterSteps( var, index = 0 )
Input Arguments
var The "Linear Iterations" variable name/index index The "Linear Iterations" index Integer String or integer
Return Value
linIterSteps The "Linear Iterations" steps values Array( Numarray )
Errors

Description
This routine returns the "Linear Iterations" steps value. The variable name or index is given by var. For example,
linSteps = adb.getLinIterSteps( 1,2 )
Version 1.8
101
getLinIterTimes( )
5.7 getLinIterTimes( )
Return the "Linear Iterations" times value
Usage
linIterTimes = adb.getLinIterTimes( var, index = 0 )
Input Arguments
Return Value
linIterTimes The "Linear Iterations" times values Array( Numarray )
Errors

Description
This routine returns the "Linear Iterations" times value. The variable name or index is given by var. For example,
linTimes = adb.getLinIterTimes( 1,2 )
Version 1.8
102
getLinIterValues( )
5.8 getLinIterValues( )
Return the "Linear Iterations" values
Usage
linIterValues = adb.getLinIterValues( var, index = 0 )
Input Arguments
Return Value
linIterValues The "Linear Iterations" values Array( Numarray )
Errors

Description
This routine returns the "Linear Iterations" values. The variable name or index is given by var. For example,
linValues = adb.getLinIterValues( 1,2 )
Version 1.8
103
getLinIterVarIndx( )
5.9 getLinIterVarIndx( )
Map the "Linear Iterations" variable into an index
Usage
varIndx = adb.getLinIterVarIndx( var )
Input Arguments
var The "Linear Iterations" variable name/index. String or integer
Return Value
varIndx The mapped index Integer
Errors
var must be a valid name or index.
Description
This routine maps the "Linear Iterations" variable into an index. The variable name or index is given by var. For example,
varIndx = adb.getLinIterVarIndx( 1 )
Version 1.8
104
getLinIterVarNames( )
5.10 getLinIterVarNames( )
Returns a list of "Linear Iterations" variable names
Usage
varNames = adb.getLinIterVarNames( )
Input Arguments
None
Return Value
varNames A list of "Linear Iterations" variable names List
Errors
None
Description
This routine returns a list of "Linear Iterations" variable names. For example,
varNames = adb.getLinIterVarNames( )
Version 1.8
105
getOeiNameIndx( )
5.11 getOeiNameIndx( )
Map the OEI name into an index
Usage
oeiNameIndx = adb.getOeiNameIndx( name )
Input Arguments
name The OEI name/index. String or integer
Return Value
oeiNameIndx The mapped index Integer
Errors
name must be a valid name or index.
Description
This routine maps the OEI name into an index. The OEI name or index is given by name. For example,
oeiNameIndx = adb.getOeiNameIndx( 1 )
Version 1.8
106
getOeiNames( )
5.12 getOeiNames( )
Return the list of OEI names
Usage
oeiNames = adb.getOeiNames( )
Input Arguments
None
Return Value
oeiNames List of OEI names List
Description
This routine returns the list of OEI names. For example,
oeiNames = adb.getOeiNames( )
Version 1.8
107
getOeiSteps( )
5.13 getOeiSteps( )
Return the list of OEI time steps
Usage
oeiSteps = adb.getOeiSteps( name )
Input Arguments
name Name or id of an OEI name Integer or String
Return Value
oeiSteps List of OEI time steps List
Description
This routine returns the list of OEI time steps. This function needs an index as argument which is given by name. For example,
oeiSteps = adb.getOeiSteps( 1 )
Version 1.8
108
getOeiTimes( )
5.14 getOeiTimes( )
Return OEI run times.
Usage
oeiTimes = adb.getOeiTimes( name )
Input Arguments
Return Value
oeiTimes List of OEI run times List
Description
This routine returns the list of OEI run times. This function needs an index as argument which is given by name. For example,
oeiTimes = adb.getOeiTimes( 3 )
Version 1.8
109
getOeiValues( )
5.15 getOeiValues( )
Return the list of OEI integrated values.
Usage
oeiVals = adb.getOeiValues( name, var, unit = None )
Input Arguments
name Name or id of an OEI name var Name or id of an OEI variable unit String Integer or String Integer or String
If unit is not None, the value will be converted to the new unit and be returned.
Return Value
oeiVals List of OEI integrated values List
Description
This routine returns the list of OEI integrated values. This function needs two indices as argument which are given by name and var. If unit is not None, the value will be converted to the new unit and be returned. For example,
trac = adb.getOeiValues( wall, traction, N )
Version 1.8
110
getOeiVarNames( )
5.16 getOeiVarNames( )
Return the list of OEI variable names.
Usage
oeiVarNames = adb.getOeiVarNames( )
Input Arguments
None
Return Value
oeiVarNames List of OEI variable names List
Description
This routine returns the list of OEI variable names. For example,
oeiVars = adb.getOeiVarNames( )
Version 1.8
111
getOeiVarUnit( )
5.17 getOeiVarUnit( )
Return the EI unit (default unit of unit category) of adb variable.
Usage
oeiVarUnit = adb.getOeiVarUnit( name )
Input Arguments
Return Value
oeiVarUnit The EI unit (default unit of unit category) of adb variable List or String
Description
This routine returns the EI unit (default unit of unit category) of adb variable. This function needs an index as argument which is given by name.For example,
oeiVarUnit = adb.getOeiVarUnit( wall )
Version 1.8
112
getOfcNameIndx( )
5.18 getOfcNameIndx( )
Map the OFC name into an index
Usage
ofcNameIndx = adb.getOfcNameIndx( name )
Input Arguments
name The OFC name/index. String or integer
Return Value
ofcNameIndx The mapped index Integer
Errors
Description
This routine maps the OFC name into an index. The OFC name or index is given by name. For example,
ofcNameIndx = adb.getOfcNameIndx( 1 )
Version 1.8
113
getOfcNames( )
5.19 getOfcNames( )
Return the list of OFC names
Usage
ofcNames = adb.getOfcNames( )
Input Arguments
None
Return Value
ofcNames List of OFC names List
Description
This routine returns the list of OFC names. For example,
ofcNames = adb.getOfcNames( )
Version 1.8
114
getOfcSteps( )
5.20 getOfcSteps( )
Return the list of OFC time steps
Usage
ofcSteps = adb.getOfcSteps( name )
Input Arguments
name Name or id of an OFC name Integer or String
Return Value
ofcSteps List of OFC time steps List
Description
This routine returns the list of OFC time steps. This function needs an index as argument which is given by name. For example,
ofcSteps = adb.getOfcSteps( 1 )
Version 1.8
115
getOfcTimes( )
5.21 getOfcTimes( )
Return OFC run times.
Usage
ofcTimes = adb.getOfcTimes( name )
Input Arguments
Return Value
ofcTimes List of OFC run times List
Description
This routine returns the list of OFC run times. This function needs an index as argument which is given by name. For example,
ofcTimes = adb.getOfcTimes( 3 )
Version 1.8
116
getOfcValues( )
5.22 getOfcValues( )
Return the list of OFC integrated values.
Usage
ofcVals = adb.getOfcValues( name, var, unit = None )
Input Arguments
name Name or id of an OFC name var Name or id of an OFC variable unit String Integer or String Integer or String
Return Value
ofcVals List of OFC integrated values List
Description
This routine returns the list of OFC integrated values. This function needs two indices as argument which are given by name and var. If unit is not None, the value will be converted to the new unit and be returned. For example,
trac = adb.getOfcValues( wall, traction, N )
Version 1.8
117
getOfcVarNames( )
5.23 getOfcVarNames( )
Return the list of OFC variable names.
Usage
ofcVarNames = adb.getOfcVarNames( )
Input Arguments
None
Return Value
ofcVarNames List of OFC variable names List
Description
This routine returns the list of OFC variable names. For example,
ofcVars = adb.getOfcVarNames( )
Version 1.8
118
getOfcVarUnit( )
5.24 getOfcVarUnit( )
Return the FC unit (default unit of unit category) of adb variable.
Usage
ofcVarUnit = adb.getOfcVarUnit( name )
Input Arguments
Return Value
ofcVarUnit The FC unit (default unit of unit category) of adb variable List or String
Description
This routine returns the FC unit (default unit of unit category) of adb variable. This function needs an index as argument which is given by name.For example,
ofcVarUnit = adb.getOfcVarUnit( wall )
Version 1.8
119
getOhcNameIndx( )
5.25 getOhcNameIndx( )
Map the OHC name into an index
Usage
ohcNameIndx = adb.getOhcNameIndx( name )
Input Arguments
name The OHC name/index. String or integer
Return Value
ohcNameIndx The mapped index Integer
Errors
Description
This routine maps the OHC name into an index. The OHC name or index is given by name. For example,
ohcNameIndx = adb.getOhcNameIndx( 1 )
Version 1.8
120
getOhcNames( )
5.26 getOhcNames( )
Return the list of OHC names
Usage
ohcNames = adb.getOhcNames( )
Input Arguments
None
Return Value
ohcNames List of OHC names List
Description
This routine returns the list of OHC names. For example,
ohcNames = adb.getOhcNames( )
Version 1.8
121
getOhcSteps( )
5.27 getOhcSteps( )
Return the list of OHC time steps
Usage
ohcSteps = adb.getOhcSteps( name )
Input Arguments
name Name or id of an OHC name Integer or String
Return Value
ohcSteps List of OHC time steps List
Description
This routine returns the list of OHC time steps. This function needs an index as argument which is given by name. For example,
ohcSteps = adb.getOhcSteps( 1 )
Version 1.8
122
getOhcTimes( )
5.28 getOhcTimes( )
Return OHC run times.
Usage
ohcTimes = adb.getOhcTimes( name )
Input Arguments
Return Value
ohcTimes List of OHC run times List
Description
This routine returns the list of OHC run times. This function needs an index as argument which is given by name. For example,
ohcTimes = adb.getOhcTimes( 3 )
Version 1.8
123
getOhcValues( )
5.29 getOhcValues( )
Return the list of OHC integrated values.
Usage
ohcVals = adb.getOhcValues( name, var, unit = None )
Input Arguments
name Name or id of an OHC name var Name or id of an OHC variable unit String Integer or String Integer or String
Return Value
ohcVals List of OHC integrated values List
Description
This routine returns the list of OHC integrated values. This function needs two indices as argument which are given by name and var. If unit is not None, the value will be converted to the new unit and be returned. For example,
trac = adb.getOhcValues( wall, traction, N )
Version 1.8
124
getOhcVarNames( )
5.30 getOhcVarNames( )
Return the list of OHC variable names.
Usage
ohcVarNames = adb.getOhcVarNames( )
Input Arguments
None
Return Value
ohcVarNames List of OHC variable names List
Description
This routine returns the list of OHC variable names. For example,
ohcVars = adb.getOhcVarNames( )
Version 1.8
125
getOhcVarUnit( )
5.31 getOhcVarUnit( )
Return the HC unit (default unit of unit category) of adb variable.
Usage
ohcVarUnit = adb.getOhcVarUnit( name )
Input Arguments
Return Value
ohcVarUnit The HC unit (default unit of unit category) of adb variable List or String
Description
This routine returns the HC unit (default unit of unit category) of adb variable. This function needs an index as argument which is given by name.For example,
ohcVarUnit = adb.getOhcVarUnit( wall )
Version 1.8
126
getOqiNameIndx( )
5.32 getOqiNameIndx( )
Map the OQI name into an index
Usage
oqiNameIndx = adb.getOqiNameIndx( name )
Input Arguments
name The OQI name/index. String or integer
Return Value
oqiNameIndx The mapped index Integer
Errors
Description
This routine maps the OQI name into an index. The OQI name or index is given by name. For example,
oqiNameIndx = adb.getOqiNameIndx( 1 )
Version 1.8
127
getOqiNames( )
5.33 getOqiNames( )
Return the list of OQI names
Usage
oqiNames = adb.getOqiNames( )
Input Arguments
None
Return Value
oqiNames List of OQI names List
Description
This routine returns the list of OQI names. For example,
oqiNames = adb.getOqiNames( )
Version 1.8
128
getOqiSteps( )
5.34 getOqiSteps( )
Return the list of OQI time steps
Usage
oqiSteps = adb.getOqiSteps( name )
Input Arguments
name Name or id of an OQI name Integer or String
Return Value
oqiSteps List of OQI time steps List
Description
This routine returns the list of OQI time steps. This function needs an index as argument which is given by name. For example,
oqiSteps = adb.getOqiSteps( 1 )
Version 1.8
129
getOqiTimes( )
5.35 getOqiTimes( )
Return OQI run times.
Usage
oqiTimes = adb.getOqiTimes( name )
Input Arguments
Return Value
oqiTimes List of OQI run times List
Description
This routine returns the list of OQI run times. This function needs an index as argument which is given by name. For example,
oqiTimes = adb.getOqiTimes( 3 )
Version 1.8
130
getOqiValues( )
5.36 getOqiValues( )
Return the list of OQI integrated values.
Usage
oqiVals = adb.getOqiValues( name, var, unit = None )
Input Arguments
name Name or id of an OQI name var Name or id of an OQI variable unit String Integer or String Integer or String
Return Value
oqiVals List of OQI integrated values List
Description
This routine returns the list of OQI integrated values. This function needs two indices as argument which are given by name and var. If unit is not None, the value will be converted to the new unit and be returned. For example,
trac = adb.getOqiValues( wall, traction, N )
Version 1.8
131
getOqiVarNames( )
5.37 getOqiVarNames( )
Return the list of OQI variable names.
Usage
oqiVarNames = adb.getOqiVarNames( )
Input Arguments
None
Return Value
oqiVarNames List of OQI variable names List
Description
This routine returns the list of OQI variable names. For example,
oqiVars = adb.getOqiVarNames( )
Version 1.8
132
getOqiVarUnit( )
5.38 getOqiVarUnit( )
Return the QI unit (default unit of unit category) of adb variable.
Usage
oqiVarUnit = adb.getOqiVarUnit( name )
Input Arguments
Return Value
oqiVarUnit The QI unit (default unit of unit category) of adb variable List or String
Description
This routine returns the QI unit (default unit of unit category) of adb variable. This function needs an index as argument which is given by name.For example,
oqiVarUnit = adb.getOqiVarUnit( wall )
Version 1.8
133
getOriNameIndx( )
5.39 getOriNameIndx( )
Map the ORI name into an index
Usage
oriNameIndx = adb.getOriNameIndx( name )
Input Arguments
name The ORI name/index. String or integer
Return Value
oriNameIndx The mapped index Integer
Errors
Description
This routine maps the ORI name into an index. The ORI name or index is given by name. For example,
oriNameIndx = adb.getOriNameIndx( 1 )
Version 1.8
134
getOriNames( )
5.40 getOriNames( )
Return the list of ORI names
Usage
oriNames = adb.getOriNames( )
Input Arguments
None
Return Value
oriNames List of ORI names List
Description
This routine returns the list of ORI names. For example,
oriNames = adb.getOriNames( )
Version 1.8
135
getOriSteps( )
5.41 getOriSteps( )
Return the list of ORI time steps
Usage
oriSteps = adb.getOriSteps( name )
Input Arguments
name Name or id of an ORI name Integer or String
Return Value
oriSteps List of ORI time steps List
Description
This routine returns the list of ORI time steps. This function needs an index as argument which is given by name. For example,
oriSteps = adb.getOriSteps( 1 )
Version 1.8
136
getOriTimes( )
5.42 getOriTimes( )
Return ORI run times.
Usage
oriTimes = adb.getOriTimes( name )
Input Arguments
Return Value
oriTimes List of ORI run times List
Description
This routine returns the list of ORI run times. This function needs an index as argument which is given by name. For example,
oriTimes = adb.getOriTimes( 3 )
Version 1.8
137
getOriValues( )
5.43 getOriValues( )
Return the list of ORI integrated values.
Usage
oriVals = adb.getOriValues( name, var, unit = None )
Input Arguments
name Name or id of an ORI name var Name or id of an ORI variable unit String Integer or String Integer or String
Return Value
oriVals List of ORI integrated values List
Description
This routine returns the list of ORI integrated values. This function needs two indices as argument which are given by name and var. If unit is not None, the value will be converted to the new unit and be returned. For example,
trac = adb.getOriValues( wall, traction, N )
Version 1.8
138
getOriVarNames( )
5.44 getOriVarNames( )
Return the list of ORI variable names.
Usage
oriVarNames = adb.getOriVarNames( )
Input Arguments
None
Return Value
oriVarNames List of ORI variable names List
Description
This routine returns the list of ORI variable names. For example,
oriVars = adb.getOriVarNames( )
Version 1.8
139
getOriVarUnit( )
5.45 getOriVarUnit( )
Return the RI unit (default unit of unit category) of adb variable.
Usage
oriVarUnit = adb.getOriVarUnit( name )
Input Arguments
Return Value
oriVarUnit The RI unit (default unit of unit category) of adb variable List or String
Description
This routine returns the RI unit (default unit of unit category) of adb variable. This function needs an index as argument which is given by name.For example,
oriVarUnit = adb.getOriVarUnit( wall )
Version 1.8
140
getOsiNameIndx( )
5.46 getOsiNameIndx( )
Map the OSI name into an index
Usage
osiNameIndx = adb.getOsiNameIndx( name )
Input Arguments
name The OSI name/index. String or integer
Return Value
osiNameIndx The mapped index Integer
Errors
Description
This routine maps the OSI name into an index. The OSI name or index is given by name. For example,
osiNameIndx = adb.getOsiNameIndx( 1 )
Version 1.8
141
getOsiNames( )
5.47 getOsiNames( )
Return the list of OSI names
Usage
osiNames = adb.getOsiNames( )
Input Arguments
None
Return Value
osiNames List of OSI names List
Description
This routine returns the list of OSI names. For example,
osiNames = adb.getOsiNames( )
Version 1.8
142
getOsiSteps( )
5.48 getOsiSteps( )
Return the list of OSI time steps
Usage
osiSteps = adb.getOsiSteps( name )
Input Arguments
name Name or id of an OSI name Integer or String
Return Value
osiSteps List of OSI time steps List
Description
This routine returns the list of OSI time steps. This function needs an index as argument which is given by name. For example,
osiSteps = adb.getOsiSteps( 1 )
Version 1.8
143
getOsiTimes( )
5.49 getOsiTimes( )
Return OSI run times.
Usage
osiTimes = adb.getOsiTimes( name )
Input Arguments
Return Value
osiTimes List of OSI run times List
Description
This routine returns the list of OSI run times. This function needs an index as argument which is given by name. For example,
osiTimes = adb.getOsiTimes( 3 )
Version 1.8
144
getOsiValues( )
5.50 getOsiValues( )
Return the list of OSI integrated values.
Usage
osiVals = adb.getOsiValues( name, var, unit = None )
Input Arguments
name Name or id of an OSI name var Name or id of an OSI variable unit String Integer or String Integer or String
Return Value
osiVals List of OSI integrated values List
Description
This routine returns the list of OSI integrated values. This function needs two indices as argument which are given by name and var. If unit is not None, the value will be converted to the new unit and be returned. For example,
trac = adb.getOsiValues( wall, traction, N )
Version 1.8
145
getOsiVarNames( )
5.51 getOsiVarNames( )
Return the list of OSI variable names.
Usage
osiVarNames = adb.getOsiVarNames( )
Input Arguments
None
Return Value
osiVarNames List of OSI variable names List
Description
This routine returns the list of OSI variable names. For example,
osiVars = adb.getOsiVarNames( )
Version 1.8
146
getOsiVarUnit( )
5.52 getOsiVarUnit( )
Return the SI unit (default unit of unit category) of adb variable.
Usage
osiVarUnit = adb.getOsiVarUnit( name )
Input Arguments
Return Value
osiVarUnit The SI unit (default unit of unit category) of adb variable List or String
Description
This routine returns the SI unit (default unit of unit category) of adb variable. This function needs an index as argument which is given by name.For example,
osiVarUnit = adb.getOsiVarUnit( wall )
Version 1.8
147
getOthNameIndx( )
5.53 getOthNameIndx( )
Map the OTH name into an index
Usage
othNameIndx = adb.getOthNameIndx( name )
Input Arguments
name The OTH name/index. String or integer
Return Value
othNameIndx The mapped index Integer
Errors
Description
This routine maps the OTH name into an index. The OTH name or index is given by name. For example,
othNameIndx = adb.getOthNameIndx( 1 )
Version 1.8
148
getOthNames( )
5.54 getOthNames( )
Return the list of OTH names
Usage
othNames = adb.getOthNames( )
Input Arguments
None
Return Value
othNames List of OTH names List
Description
This routine returns the list of OTH names. For example,
othNames = adb.getOthNames( )
Version 1.8
149
getOthNodes( )
5.55 getOthNodes( )
Return a list of OTH nodes
Usage
othNodes = adb.getOthNodes( )
Input Arguments
None
Return Value
othNodes List of OTH nodes List
Description
This routine returns the list of OTH nodes. For example,
othNodes = adb.getOthNodes( )
Version 1.8
150
getOthSteps( )
5.56 getOthSteps( )
Return the list of OTH time steps
Usage
othSteps = adb.getOthSteps( name )
Input Arguments
name Name or id of an OTH name Integer or String
Return Value
othSteps List of OTH time steps List
Description
This routine returns the list of OTH time steps. This function needs an index as argument which is given by name. For example,
othSteps = adb.getOthSteps( 1 )
Version 1.8
151
getOthTimes( )
5.57 getOthTimes( )
Return OTH run times.
Usage
othTimes = adb.getOthTimes( name )
Input Arguments
Return Value
othTimes List of OTH run times List
Description
This routine returns the list of OTH run times. This function needs an index as argument which is given by name. For example,
othTimes = adb.getOthTimes( 3 )
Version 1.8
152
getOthValues( )
5.58 getOthValues( )
Return the list of OTH integrated values.
Usage
othVals = adb.getOthValues( name, node, var, unit = None )
Input Arguments
name Name or id of an OTH name node Name or index of an OTH node var Name or id of an OTH variable unit String Integer or String Integer or String Integer or String
Return Value
othVals List of OTH integrated values List
Description
This routine returns the list of OTH integrated values. This function needs three indices as argument which are given by name, node and var. If unit is not None, the value will be converted to the new unit and be returned. For example,
othVals = adb.getOthValues( 0, 1, 3 )
Version 1.8
153
getOthVarNames( )
5.59 getOthVarNames( )
Return the list of OTH variable names.
Usage
othVarNames = adb.getOthVarNames( )
Input Arguments
None
Return Value
othVarNames List of OTH variable names List
Description
This routine returns the list of OTH variable names. For example,
othVars = adb.getOthVarNames( )
Version 1.8
154
getOthVarUnit( )
5.60 getOthVarUnit( )
Return the TH unit (default unit of unit category) of adb variable.
Usage
othVarUnit = adb.getOthVarUnit( name )
Input Arguments
Return Value
othVarUnit The TH unit (default unit of unit category) of adb variable List or String
Description
This routine returns the TH unit (default unit of unit category) of adb variable. This function needs an index as argument which is given by name.For example,
othVarUnit = adb.getOthVarUnit( wall )
Version 1.8
155
getResRatioData( )
5.61 getResRatioData( )
Return the "Residual Ratio" steps, times and values data
Usage
resRatioData = adb.getResRatioData( var, type = all )
Input Arguments
var The "Residual Ratio" variable name/index. type The type value; 'all', 'initial' and 'final'. String String or integer
Return Value
resRatioData The "Residual Ratio" data Tuple( of arrays )
Errors

var must be a valid name or index. type must be 'all', 'initial' or 'final'.
Description
This routine returns the "Residual Ratio" steps, times and values data. The "Residual Ratio" name or index is given by var. For example,
resRatioData = adb.getResRatioData( velocity )
Version 1.8
156
getResRatioSteps( )
5.62 getResRatioSteps( )
Return the "Residual Ratio" steps value
Usage
resRatioSteps = adb.getResRatioSteps( var, type = all )
Input Arguments
Return Value
resRatioSteps The "Residual Ratio" step values Numarray
Errors

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 )
Version 1.8
157
getResRatioTimes( )
5.63 getResRatioTimes( )
Return the "Residual Ratio" times value
Usage
resRatioTimes = adb.getResRatioTimes( var, type = all )
Input Arguments
Return Value
resRatioTimes The "Residual Ratio" time values Numarray
Errors

Description
This routine returns the "Residual Ratio" times value. The "Residual Ratio" name or index is given by var. For example,
resRatioTimes = adb.getResRatioTimes( velocity )
Version 1.8
158
getResRatioValues( )
5.64 getResRatioValues( )
Return the "Residual Ratio" values
Usage
resRatioValues = adb.getResRatioValues( var, type = all, unit = None )
Input Arguments
var The "Residual Ratio" variable name/index. type The type value; 'all', 'initial' and 'final'. unit The "Residual Ratio" variable unit. String String String or integer
Return Value
resRatioValues The "Residual Ratio" values Numarray
Errors

Description
This routine returns the "Residual Ratio" values. The "Residual Ratio" name or index is given by var. For example,
Version 1.8
159
getResRatioValues( )
resRatioValues = adb.getResRatioValues( velocity )
Version 1.8
160
getResRatioVarIndx( )
5.65 getResRatioVarIndx( )
Map the "Residual Ratio" variable into an index
Usage
resRatioVarIndx = adb.getResRatioVarIndx( var )
Input Arguments
var The "Residual Ratio" variable name/index. String or integer
Return Value
resRatioVarIndx The mapped index Integer
Errors
Description
This routine returns "Residual Ratio" variable into an index. The "Residual Ratio" name or index is given by var. For example,
resRatioVarIdx = adb.getResRatioVarIndx( velocity )
Version 1.8
161
getResRatioVarNames( )
5.66 getResRatioVarNames( )
Return a list of "Residual Ratio" variable names
Usage
resRatioVarNames = adb.getResRatioVarNames( )
Input Arguments
None
Return Value
resRatioVarNames A list of "Residual Ratio" variable names List
Description
This routine returns a list of "Residual Ratio" variable names. For example,
resRatioVarNames = adb.getResRatioVarNames( )
Version 1.8
162
getResRatioVarUnit( )
5.67 getResRatioVarUnit( )
Return the SI unit of the "Residual Ratio" variable
Usage
resRatioVarUnit = adb.getResRatioVarUnit( name )
Input Arguments
name The "Residual Ratio" variable name String
Return Value
resRatioVarUnit The SI unit of the variable String
Errors
name must be a valid name
Description
This routine returns the SI unit of the "Residual Ratio" variable. The "Residual Ratio" name is given by name. For example,
resRatioVarUnit = adb.getResRatioVarUnit( velocity )
Version 1.8
163
getSolRatioData( )
5.68 getSolRatioData( )
Return the "Solution Ratio" steps, times and values data
Usage
solRatioData = adb.getSolRatioData( var, type = all )
Input Arguments
var The "Solution Ratio" variable name/index. type The type value; 'all', 'initial' and 'final'. String String or integer
Return Value
solRatioData The "Solution Ratio" data Tuple( of arrays )
Errors

Description
This routine returns the "Solution Ratio" steps, times and values data. The "Solution Ratio" name or index is given by var. For example,
solRatioData = adb.getSolRatioData( pressure )
Version 1.8
164
getSolRatioSteps( )
5.69 getSolRatioSteps( )
Return the "Solution Ratio" steps value
Usage
solRatioSteps = adb.getSolRatioSteps( var, type = all )
Input Arguments
Return Value
solRatioSteps The "Solution Ratio" step values Numarray
Errors

Description
This routine returns the "Solution Ratio" steps value. The "Solution Ratio" name or index is given by var. For example,
solRatioSteps = adb.getSolRatioSteps( pressure )
Version 1.8
165
getSolRatioTimes( )
5.70 getSolRatioTimes( )
Return the "Solution Ratio" times value
Usage
solRatioTimes = adb.getSolRatioTimes( var, type = all )
Input Arguments
Return Value
solRatioTimes The "Solution Ratio" time values Numarray
Errors

Description
This routine returns the "Solution Ratio" times value. The "Solution Ratio" name or index is given by var. For example,
solRatioTimes = adb.getSolRatioTimes( pressure )
Version 1.8
166
getSolRatioValues( )
5.71 getSolRatioValues( )
Return the "Solution Ratio" values
Usage
solRatioValues = adb.getSolRatioValues( var, type = all, unit = None )
Input Arguments
var The "Solution Ratio" variable name/index. type The type value; 'all', 'initial' and 'final'. unit The "Solution Ratio" variable unit. String String String or integer
Return Value
solRatioValues The "Solution Ratio" values Numarray
Errors

Description
This routine returns the "Solution Ratio" values. The "Solution Ratio" name or index is given by var. For example,
Version 1.8
167
getSolRatioValues( )
solRatioValues = adb.getSolRatioValues( pressure )
Version 1.8
168
getSolRatioVarIndx( )
5.72 getSolRatioVarIndx( )
Map the "Solution Ratio" variable into an index
Usage
solRatioVarIndx = adb.getSolRatioVarIndx( var )
Input Arguments
var The "Solution Ratio" variable name/index. String or integer
Return Value
solRatioVarIndx The mapped index Integer
Errors
Description
This routine returns "Solution Ratio" variable into an index. The "Solution Ratio" name or index is given by var. For example,
solRatioVarIdx = adb.getSolRatioVarIndx( pressure )
Version 1.8
169
getSolRatioVarNames( )
5.73 getSolRatioVarNames( )
Return a list of "Solution Ratio" variable names
Usage
solRatioVarNames = adb.getSolRatioVarNames( )
Input Arguments
None
Return Value
solRatioVarNames A list of "Solution Ratio" variable names List
Description
This routine returns a list of "Solution Ratio" variable names. For example,
solRatioVarNames = adb.getSolRatioVarNames( )
Version 1.8
170
getSolRatioVarUnit( )
5.74 getSolRatioVarUnit( )
Return the SI unit of the "Solution Ratio" variable
Usage
solRatioVarUnit = adb.getSolRatioVarUnit( name )
Input Arguments
name The "Solution Ratio" variable name String
Return Value
solRatioVarUnit The SI unit of the variable String
Errors
name must be a valid name
Description
This routine returns the SI unit of the "Solution Ratio" variable. The "Solution Ratio" name is given by name. For example,
solRatioVarUnit = adb.getSolRatioVarUnit( pressure )
Version 1.8
171
getSteps( )
5.75 getSteps( )
Return the "Run Data" steps value
Usage
steps = adb.getSteps( )
Input Arguments
None
Return Value
steps The steps values Numarray
Description
This routine returns the "Run Data" steps value. For example,
steps = adb.getSteps( )
Version 1.8
172
getTimeIncs( )
5.76 getTimeIncs( )
Return the "Time Increment" value
Usage
timeIncs = adb.getTimeIncs( )
Input Arguments
None
Return Value
timeIncs The "Time Increment" values Numarray
Description
This routine returns the "Time Increment" values. For example,
timeIncs = adb.getTimeIncs( )
Version 1.8
173
getTimes( )
5.77 getTimes( )
Return the "Run Data" times value
Usage
times = adb.getTimes( )
Input Arguments
None
Return Value
times The times values Numarray
Description
This routine returns the times values. For example,
times = adb.getTimes( )
Version 1.8
174
getVarUnit( )
5.78 getVarUnit( )
Return the SI unit of the variable according to its adb name
Usage
varUnit = adb.getVarUnit( name, adbOut )
Input Arguments
name The variable name adbOut Related adb out name. String String
Return Value
varUnit The variable SI unit String
Description
This routine Returns the SI unit of the variable according to its adb name. For example,
osiUnit = adb.getVarUnit( "pressure", "osi" )
Version 1.8
175
3D Plot Functions
CHAPTER 6.
3D Plot Functions
The 3D plot functions role is to show and change 3D visualization view of the problem. The functions in this part show the problem model ( Volumes, Surfaces, Nodes, Perdiodics, etc. ). One can change the different properties of the model and scenegraph using these functions. The 3D Plot package is called AcuVis.It is a post processing package with the following functionalities and operations: 1. Initialize a Scene Graph and populate the scene graph with the volumes, surfaces, nodes and periodics of a solved problem (acudb). 2. Capture images into individual frames, in external files (e.g., .png) 3. Provide access to the volumes, surfaces, etc., for the purpose of changing display properties. 4. Add contour plot and velocity vectors. 5. Extract cut plane and iso surface from the volumes and add to the list of surfaces. 6. Change time step 7. Set the display orientation 8. Create animations 9. Add annotation This chapter will describe these functions in details.
Version 1.8
176
3D Plot Functions
Initialization
6.1 Initialization
This is the initialization function of AcuVis documented in this section:
AcuVis()
Create an object of AcuVis and initializes its values
Version 1.8
177
3D Plot Functions
AcuVis( )
6.1.1 AcuVis( )
Create an object of AcuVis
Usage
vis = AcuVis( problem, dir= 'ACUSIM.DIR', run= 0, outPutDir = '.' )
Input Arguments
problem Name of the AcuSolve solved problem dir Name of working directory run Run number outPutDir String Integer String String
Name of the directory where the outputs( figures and reports are placed )
Return Value
vis AcuVis object Object
Errors
Working directory must exist and have the required information.
Version 1.8
178
3D Plot Functions
AcuVis( )
Description
This routine creates an object of AcuVis and initializes its values. The problem name, working directory and run number are given by name, dir, run. The output figures will be placed in outPutDir.For example,
vis = AcuVis( problem = pump )
Version 1.8
179
3D Plot Functions
Volume Access Functions
6.2 Volume Access Functions

These are the support functions documented in this section:

getNVols() getVolName() getVolActor()
Return the number of Volumes Return the name of a volume Return a volume actor
Version 1.8
180
3D Plot Functions
getNVols( )
6.2.1 getNVols( )
Return the number of Volumes.
Usage
nVols = vis.getNVols( )
Input Arguments
None
Return Value
nVols Number of volumes Integer
Errors
None
Description
This routine returns the number of Volumes. For example,
nVols = vis.getNVols( )
Version 1.8
181
3D Plot Functions
getVolName( )
6.2.2 getVolName( )
Return the name of a volume specified by its Id.
Usage
volName = vis.getVolName( volId )
Input Arguments
volId Volume Id Integer
Return Value
volName Volume name corresponding to the volume id String
Errors
volId should be valid .
Description
This routine returns the name of a volume specified by its Id which is given by volId. For example,
volName = vis.getVolName( 1 )
Version 1.8
182
3D Plot Functions
getVolActor( )
6.2.3 getVolActor( )
Return volume actor specified by its information.
Usage
volActor = vis.getVolActor( volInfo )
Input Arguments
volInfo Name or Id of a volume Integer or String
Return Value
volActor Volume actor corresponding to the volInfo Object
Errors
volInfo should be valid .
Description
This routine returns the volume actor specified by its name or id which is given by volInfo. For example,
imp = vis.getVolActor( "impeller" )
Version 1.8
183
3D Plot Functions
Surface Access Functions
6.3 Surface Access Functions


getNSrfs() getSrfName() getSrfActor()
Return the number of Surfaces Return the name of a surface Return a surface actor
Version 1.8
184
3D Plot Functions
getNSrfs( )
6.3.1 getNSrfs( )
Return the number of Surfaces.
Usage
nSrfs = vis.getNSrfs( )
Input Arguments
None
Return Value
nSrfs Number of surfaces Integer
Errors
None
Description
This routine returns the number of Surfaces. For example,
nSrfs = vis.getNSrfs( )
Version 1.8
185
3D Plot Functions
getSrfName( )
6.3.2 getSrfName( )
Return the name of a surface specified by its Id.
Usage
srfName = vis.getSrfName( srfId )
Input Arguments
srfId Surface Id Integer
Return Value
srfName Surface name corresponding to the surface id String
Errors
srfId should be valid .
Description
This routine returns the name of a surface specified by its Id which is given by srfId. For example,
srfName = vis.getSrfName( 1 )
Version 1.8
186
3D Plot Functions
getSrfActor( )
6.3.3 getSrfActor( )
Return surface actor specified by its information.
Usage
srfActor = vis.getSrfActor( srfInfo )
Input Arguments
srfInfo Name or Id of a surface Integer or String
Return Value
srfActor Surface actor corresponding to the srfInfo Object
Errors
srfInfo should be valid .
Description
This routine returns the surface actor specified by its name or id which is given by srfInfo. For example,
fan = vis.getSrfActor( "impeller" )
Version 1.8
187
3D Plot Functions
Periodics Access Functions
6.4 Periodics Access Functions


getNPbcs() getPbcName() getPbcActor()
Return the number of Periodics Return the name of a periodic Return a periodic actor
Version 1.8
188
3D Plot Functions
getNPbcs( )
6.4.1 getNPbcs( )
Return the number of Periodics.
Usage
nPbcs = vis.getNPbcs( )
Input Arguments
None
Return Value
nPbcs Number of periodics Integer
Errors
None
Description
This routine returns the number of Periodics. For example,
nPbcs = vis.getNPbcs( )
Version 1.8
189
3D Plot Functions
getPbcName( )
6.4.2 getPbcName( )
Return the name of a periodic specified by its Id.
Usage
pbcName = vis.getPbcName( pbcId )
Input Arguments
pbcId Periodic Id Integer
Return Value
pbcName Periodic name corresponding to the periodic id String
Errors
pbcId should be valid .
Description
This routine returns the name of a periodic specified by its Id which is given by pbcId. For example,
pbcName = vis.getPbcName( 1 )
Version 1.8
190
3D Plot Functions
getPbcActor( )
6.4.3 getPbcActor( )
Return periodic actor specified by its information.
Usage
pbcActor = vis.getPbcActor( pbcInfo )
Input Arguments
pbcInfo Name or Id of a periodic Integer or String
Return Value
pbcActor Periodic actor corresponding to the pbcInfo Object
Errors
pbcInfo should be valid .
Description
This routine returns the periodic actor specified by its name or id which is given by pbcInfo. For example,
pbc = vis.getPbcActor( 0 )
Version 1.8
191
3D Plot Functions
Nodes Access Functions
6.5 Nodes Access Functions


getNNbcs() getNbcName() getNbcActor()
Return the number of Nodes Return the name of a node Return a node actor
Version 1.8
192
3D Plot Functions
getNNbcs( )
6.5.1 getNNbcs( )
Return the number of Nodes.
Usage
nNbcs = vis.getNNbcs( )
Input Arguments
None
Return Value
nNbcs Number of nodes Integer
Errors
None
Description
This routine returns the number of Nodes. For example,
nNbcs = vis.getNNbcs( )
Version 1.8
193
3D Plot Functions
getNbcName( )
6.5.2 getNbcName( )
Return the name of a node specified by its Id.
Usage
nbcName = vis.getNbcName( nbcId )
Input Arguments
nbcId Node Id Integer
Return Value
nbcName Node name corresponding to the node id String
Errors
nbcId should be valid .
Description
This routine returns the name of a node specified by its Id which is given by nbcId. For example,
nbcName = vis.getNbcName( 1 )
Version 1.8
194
3D Plot Functions
getNbcActor( )
6.5.3 getNbcActor( )
Return node actor specified by its information.
Usage
nbcActor = vis.getNbcActor( nbcInfo )
Input Arguments
nbcInfo Name or Id of a node Integer or String
Return Value
nbcActor Node actor corresponding to the nbcInfo Object
Errors
nbcInfo should be valid .
Description
This routine returns the node actor specified by its name or id which is given by nbcInfo. For example,
nbc = vis.getNbcActor( 1 )
Version 1.8
195
3D Plot Functions
Scalar and Vector Variables Functions
6.6 Scalar and Vector Variables Functions


getNVars() getVarName() getVarDim() getNSclrVars() getSclrVarName() getNVecVars() getVecVarName() setSclVar() setSclrLimits() setVecVar() setVecScale()
Return the number of variables Return the name of a variable Return dimension of a variable Return the number of scalar variables Return a scalar variable name Return the number of vector variables Return a vector variable name Set the current scalar variable Set the minimum and maximum limits of current scalar variable Set the current vector variable Set the vector scale of current vector variable
Version 1.8
196
3D Plot Functions
getNVars( )
6.6.1 getNVars( )
Return the number of variables (both Scalar and Vector variables).
Usage
nVars = vis.getNVars( )
Input Arguments
None
Return Value
nVars Number of scalar and vector variables Integer
Errors
None
Description
This routine returns the number of both scalar and vector variables. For example,
nVars = vis.getNVars( )
Version 1.8
197
3D Plot Functions
getVarName( )
6.6.2 getVarName( )
Return the name of a variable corresponds to varId.
Usage
varName = vis.getVarName( varId )
Input Arguments
varId Variable Id Integer
Return Value
varName Variable name corresponding to the variable id String
Errors
varId should be valid .
Description
This routine returns the name of a variable specified by its Id which is given by varId. For example,
varName = vis.getVarName( 2 )
Version 1.8
198
3D Plot Functions
getVarDim( )
6.6.3 getVarDim( )
Return dimension of a variable which corresponds to varInfo( variable name or id).
Usage
varDim = vis.getVarDim( varInfo )
Input Arguments
varInfo Name or Id of a variable Integer or String
Return Value
varDim Dimension of the variable corresponding to the varInfo Integer
Errors
varInfo should be valid .
Description
This routine returns dimension of a variable which corresponds to varInfo which is name or id of variable. For example,
varDim = vis.getVarDim( velocity )
Version 1.8
199
3D Plot Functions
getNSclrVars( )
6.6.4 getNSclrVars( )
Return the number of scalar variables.
Usage
nSVars = vis.getNSclrVars( )
Input Arguments
None
Return Value
nSVars Number of scalar variables Integer
Errors
None
Description
This routine returns number of scalar variables. For example,
nSVars = vis.getNSclrVars( )
Version 1.8
200
3D Plot Functions
getSclrVarName( )
6.6.5 getSclrVarName( )
Return a scalar variable name corresponds to variable Id.
Usage
sclrVarName = vis.getSclrVarName( varId )
Input Arguments
varId Variable id Integer
Return Value
sclrVarName Name of the scalar variable corresponding to the varId String
Errors
Description
This routine returns a scalar variable name corresponds to varId. For example,
sclrVarName = vis.getSclrVarName( 2 )
Version 1.8
201
3D Plot Functions
getNVecVars( )
6.6.6 getNVecVars( )
Return the number of vector variables.
Usage
nVVars = vis.getNVecVars( )
Input Arguments
None
Return Value
nVVars Number of vector variables Integer
Errors
None
Description
This routine returns number of vector variables. For example,
nVVars = vis.getNVecVars( )
Version 1.8
202
3D Plot Functions
getVecVarName( )
6.6.7 getVecVarName( )
Return a vector variable name corresponds to variable Id.
Usage
vecVarName = vis.getVecVarName( varId )
Input Arguments
varId Variable id Integer
Return Value
vecVarName Name of the vector variable corresponding to the varId String
Errors
Description
This routine returns a vector variable name corresponds to varId. For example,
vecName = vis.getVecVarName( 0 )
Version 1.8
203
3D Plot Functions
setSclVar( )
6.6.8 setSclVar( )
Set the current scalar variable to variable information ( scalar variable name or id ).
Usage
vis.setSclrVar( varInfo )
Input Arguments
varInfo Variable id or variable name Integer or String
Return Value
None
Errors
varInfo should be valid .
Description
This routine sets the current scalar variable to varInfo. The varInfo could be name or id of the scalar variable. For example,
vis.setSclrVar( "pressure" )
Version 1.8
204
3D Plot Functions
setSclrLimits( )
6.6.9 setSclrLimits( )
Set the minimum and maximum limits of current scalar field.
Usage
vis.setSclrLimits( minVal = None, maxVal = None )
Input Arguments
minVal Minimum value of the scalar variable maxVal Maximum value of the scalar variable Integer Integer
Return Value
None
Errors
minval and maxVal should be integer .
Description
This routine sets the minimum and maximum limits of current scalar field to minVal and maxVal. For example,
vis.setSclrLimits(
10,
50
Version 1.8
205
3D Plot Functions
setVecVar( )
6.6.10 setVecVar( )
Set the current vector variable to variable information ( vector variable name or id ).
Usage
vis.setVecVar( varInfo )
Input Arguments
varInfo Variable id or variable name Integer or String
Return Value
None
Errors
minval and maxVal should be integer .
Description
This routine sets the current vector variable to varInfo. The varInfo could be name or id of the vector variable. For example,
vis.setVecVar( "velocity" )
Version 1.8
206
3D Plot Functions
setVecScale( )
6.6.11 setVecScale( )
Set the vector scale of current vector field.
Usage
vis.setVecScale( vecScale )
Input Arguments
vecScale Vector scale Integer
Return Value
None
Errors
vecScale should be integer .
Description
This routine sets the vector scale of current vector field to vecScale. For example,
vis.setVecScale( 5 )
Version 1.8
207
3D Plot Functions
Iso-surface and Cut-plane Functions
6.7 Iso-surface and Cut-plane Functions


addIsoSurface() getNIsos() getIsoName() getIsoActor() delIsoActor() addCPlane() getNCpls() getCplName() getCplActor() delCplActor()
Create an IsoSurface actor Return the number of iso-surface actors Return name of an iso-surface Return an iso-surface actor Removes an iso-surface actor Create a cut-plane actor Return the number of cut-plane actors Return name of a cut-plane Return a cut-plane actor Remove a cut-plane actor
Version 1.8
208
3D Plot Functions
addIsoSurface( )
6.7.1 addIsoSurface( )
Create an IsoSurface actor
Usage
isoActor = vis.addIsoSurface( isoVec, isoVal, name, vols = None )
Input Arguments
isoVec Iso-surface vector isoVal Iso-surface value name Optional name vols Volume(s) List or String or Integer String Integer List or String
Return Value
isoActor Iso-surface actor Object
Errors
vols should includes valid volumes or be None.
Version 1.8
209
3D Plot Functions
addIsoSurface( )
Description
This routine creates an IsoSurface actor from the vols based on the isoVec and isoVal, named it name and adds its actor to Scene Graph. For example,
pres = vis.addIsoSurface( "pressure", 0.1, "pres-iso"
Version 1.8
210
3D Plot Functions
getNIsos( )
6.7.2 getNIsos( )
Return the number of iso-surface actors
Usage
nIsos = vis.getNIsos( )
Input Arguments
None
Return Value
nIsos Number of iso-surface actors Integer
Errors
None
Description
This routine returns the number of iso-surface actors. For example,
Version 1.8
211
3D Plot Functions
getIsoName( )
6.7.3 getIsoName( )
Return name of an iso-surface object
Usage
isoName = vis.getIsoName( isoId )
Input Arguments
isoId Iso-surface id Integer
Return Value
isoName Iso-surface name String
Errors
isoId should be valid
Description
This routine returns name of an iso-surface object which is specified by its Id isoId. For example,
for i in range(nIsos): name = vis.getIsoName(
Version 1.8
212
3D Plot Functions
getIsoActor( )
6.7.4 getIsoActor( )
Return an iso-surface actor
Usage
isoActor = vis.getIsoActor( isoInfo )
Input Arguments
isoInfo Iso-surface Name or Id Integer or String
Return Value
isoActor Iso-surface actor Object
Errors
isoInfo should be valid
Description
This routine returns iso-surface actor which is specified by isoInfo.The isoInfo could be iso-surface id o name. For example,
actor = vis.getIsoActor( "pres-iso" )
Version 1.8
213
3D Plot Functions
delIsoActor( )
6.7.5 delIsoActor( )
Remove an iso-surface actor
Usage
vis.delIsoActor( isoInfo )
Input Arguments
isoInfo Iso-surface Name or Id Integer or String
Return Value
None
Errors
isoInfo should be valid
Description
This routine removes an iso-surface actor which is specified by isoInfo from scene graph.The isoInfo could be iso-surface id o name. For example,
vis.delIsoActor( "pres-iso" )
Version 1.8
214
3D Plot Functions
addCPlane( )
6.7.6 addCPlane( )
Create a cut-plane actor
Usage
cplActor = vis.addCPlane( point1, point2, point3, name, vols = None )
Input Arguments
point1 Point 1 information point2 Point 2 information point3 Point 3 information name Optional name vols Volume(s) List or String or Integer String List List List
Return Value
cplActor Cut-plane actor Object
Errors
vols should includes valid volumes or be None.
Version 1.8
215
3D Plot Functions
addCPlane( )
Description
This routine creates a Cut-Plane actor from the vols based on the point1, point2 and point3, named it name and adds its actor to Scene Graph. For example,
imp impBbox xmin xmax ymin ymax zmin zmax ymid cpl = = = = = = = = = vis.getVolActor( "impeller" ) imp.bndBox( ) bndBox[0][0] bndBox[0][1] bndBox[1][0] bndBox[1][1] bndBox[1][0] bndBox[1][1] ( impBbox[1][0] + impBbox[1][1] ) / 2 [xmin, ymid, zmin], [xmax, ymid, zmin], [xmax, ymid, zmax], "mid-plane"
= vis.addCPlane(
Version 1.8
216
3D Plot Functions
getNCpls( )
6.7.7 getNCpls( )
Return the number of cut-plane actors
Usage
nCpls = vis.getNCpls( )
Input Arguments
None
Return Value
nCpls Number of cut-plane actors Integer
Errors
None
Description
This routine returns the number of cut-plane actors. For example,
Version 1.8
217
3D Plot Functions
getCplName( )
6.7.8 getCplName( )
Return name of a cut-plane object
Usage
cplName = vis.getCplName( cplId )
Input Arguments
cplId Cut-plane id Integer
Return Value
cplName Cut-plane name String
Errors
cplId should be valid
Description
This routine returns name of a cut-plane object which is specified by its Id cplId. For example,
for i in range(nCpls): name = vis.getCplName(
Version 1.8
218
3D Plot Functions
getCplActor( )
6.7.9 getCplActor( )
Return a cut-plane actor
Usage
cplActor = vis.getCplActor( cplInfo )
Input Arguments
cplInfo Cut-plane Name or Id Integer or String
Return Value
cplActor Cut-plane actor Object
Errors
cplInfo should be valid
Description
This routine returns cut-plane actor which is specified by cplInfo.The cplInfo could be cut-plane id o name. For example,
actor = vis.getCplActor( "mid-plane" )
Version 1.8
219
3D Plot Functions
delCplActor( )
6.7.10 delCplActor( )
Removes a cut-plane actor
Usage
vis.delCplActor( cplInfo )
Input Arguments
cplInfo Cut-plane Name or Id Integer or String
Return Value
None
Errors
cplInfo should be valid
Description
This routine removes a cut-plane actor which is specified by cplInfo from scene graph.The cplInfo could be cut-plane id o name. For example,
vis.delCplActor( 0 )
Version 1.8
220
3D Plot Functions
Iso_line functions
6.8 Iso_line functions


addIsoLine() getNIsoLns() getIsoLnName() getIsoLnActor() delIsoLnActor()
Create an IsoLine actor Return the number of iso-line actors Return name of an iso-ine Return an iso-line actor Removes an iso-line actor
Version 1.8
221
3D Plot Functions
addIsoLine( )
6.8.1 addIsoLine( )
Create an IsoLine actor
Usage
isoLnActor = vis.addIsoLine( isoVec, isoVal, name, srfs = None )
Input Arguments
isoVec Iso-line vector isoVal Iso-line value name Optional name srfs Surface(s) List or String or Integer String Integer List or String
Return Value
isoLnActor Iso-line actor Object
Errors
srfs should includes valid surfaces or be None.
Version 1.8
222
3D Plot Functions
addIsoLine( )
Description
This routine creates an IsoLine actor from the srfs based on the isoVec and isoVal, named it name and adds its actor to Scene Graph. For example,
pMin = vis.sclrValue.min() pMax = vis.sclrValue.max() dp = (pMax - pMin) / 11 for i in range(10): pVal = i *1 + 4 pres = vis.addIsoLine( "pressure", pVal, "pres-isoLine", 'wall'
Version 1.8
223
3D Plot Functions
getNIsoLns( )
6.8.2 getNIsoLns( )
Return the number of iso-line actors
Usage
nIsoLns = vis.getNIsoLns( )
Input Arguments
None
Return Value
nIsoLns Number of iso-line actors Integer
Errors
None
Description
This routine returns the number of iso-line actors. For example,
Version 1.8
224
3D Plot Functions
getIsoLnName( )
6.8.3 getIsoLnName( )
Return name of an iso-line object
Usage
isoLnName = vis.getIsoLnName( isoLnId )
Input Arguments
isoLnId Iso-line id Integer
Return Value
isoLnName Iso-line name String
Errors
isoLnId should be valid
Description
This routine returns name of an iso-line object which is specified by its Id isoLnId. For example,
for i in range(nIsoLns): name = vis.getIsoLnName(
Version 1.8
225
3D Plot Functions
getIsoLnActor( )
6.8.4 getIsoLnActor( )
Return an iso-line actor
Usage
isoLnActor = vis.getIsoLnActor( isoLnInfo )
Input Arguments
isoLnInfo Iso-line Name or Id Integer or String
Return Value
isoLnActor Iso-line actor Object
Errors
isoLnInfo should be valid
Description
This routine returns iso-line actor which is specified by isoLnInfo.The isoLnInfo could be iso-line id o name. For example,
actor = vis.getIsoLnActor( "pres-isoLine" )
Version 1.8
226
3D Plot Functions
delIsoLnActor( )
6.8.5 delIsoLnActor( )
Remove an iso-line actor
Usage
vis.delIsoLnActor( isoLnInfo )
Input Arguments
isoLnInfo Iso-line Name or Id Integer or String
Return Value
None
Errors
isoLnInfo should be valid
Description
This routine removes an iso-line actor which is specified by isoLnInfo from scene graph.The isoLnInfo could be iso-line id o name. For example,
vis.delIsoLnActor( "pres-isoLine" )
Version 1.8
227
3D Plot Functions
Tufts functions
6.9 Tufts functions


addTufts() delTufts()
Create a tuft actor Removes a tuft actor
Version 1.8
228
3D Plot Functions
addTufts( )
6.9.1 addTufts( )
Create a Tufts actor
Usage
tufts = vis.addTufts( points, name, vols = None )
Input Arguments
points List Random points which should be projected to create tufts actor name Optional name vols Volume(s) List or String or Integer String
Return Value
tufts Tufts actor Object
Errors
vols should includes valid volums or be None.
Description
This routine creates a Tufts actor from the vols , named it name and adds its actor to Scene Graph. For example,
points = vis.genPoints( type = "2d_grid",
Version 1.8
229
3D Plot Functions
addTufts( )
tufts
= vis.addTufts(
point1 = [xmin, ymid, zmin], point2 = [xmax, ymid, zmin], point3 = [xmax, ymid, zmax], nXPoints= 100, nYPoints= 100 ) points, "mid-plane" , 'impeller')
Version 1.8
230
3D Plot Functions
delTufts( )
6.9.2 delTufts( )
Remove a tufts actor
Usage
vis.delTufts( tuftsInfo )
Input Arguments
TuftsInfo Tufts Name or Id Integer or String
Return Value
None
Errors
tuftsInfo should be valid
Description
This routine removes a tufts actor which is specified by tuftsInfo from scene graph.The tuftsInfo could be tufts id o name. For example,
vis.delTufts( "mid-plane" )
Version 1.8
231
3D Plot Functions
Clip Plane functions
6.10 Clip Plane functions


addClipPlane() delClipPlane() active()
Creates a clip plane for an actor Removes a clip plane from an actor Activate\de-activate the clip plane of an actor
Version 1.8
232
3D Plot Functions
addClipPlane( )
6.10.1 addClipPlane( )
Create a Clip Plane for an actor
Usage
clipPlane = vis.addClipPlane( point1, point2, point3, side = 'up', actor = None )
Input Arguments
point1 Point1 used for creating clip plane point2 Point1 used for creating clip plane point3 Point3 used for creating clip plane side Side of the clip plane. actor Object String List List List
The actor which the clipping is applied to it. If actor is None (the default), the clipping is applied to all 3D objects.
Return Value
clipPlane Clip Plane object Object
Version 1.8
233
3D Plot Functions
addClipPlane( )
Errors
actor should already be created and be valid.
Description
This routine creates a clip plane for the specified actor , and adds it to Scene Graph. If actor is None( the default), the clipping is applied to all 3D objects. For example,
bndBox = vis.bndBox()
imp = vis.getVolActor( "impeller" ) impBbox = imp.bndBox() xmin xmax ymin ymax zmin zmax ymid clp = = = = = = = bndBox[0][0] bndBox[0][1] bndBox[1][0] bndBox[1][1] bndBox[1][0] bndBox[1][1] (impBbox[1][0] + impBbox[1][1] ) / 2 ymid, zmin], ymid, zmin], ymid, zmax], "up"
= vis.addClipPlane( [xmin, [xmax, [xmax, side =
Version 1.8
234
3D Plot Functions
delClipPlane( )
6.10.2 delClipPlane( )
Remove a clip plane from an actor
Usage
vis.delClipPlane( actor = None )
Input Arguments
actor Object The actor which its clip plane should be removed. If actor is None, all the 3D objectss clip plane will be removed.
Return Value
None
Errors
actor should be valid
Description
This routine removes the clip plane from an actor which is specified by actor.If actor is None, all the 3D objectss clip plane will be removed.. For example,
vis.delClipPlane( )
Version 1.8
235
3D Plot Functions
activeClipPlane( )
6.10.3 activeClipPlane( )
Activate/de-activate the clip plane of an actor
Usage
vis.activeClipPlane( active = True, actor = None )
Input Arguments
active Boolean This flag indicates if the clip plane should be activated or de-activated. actor Object
The actor which its clip plane should be activated\de-activated.. If actor is None, all the 3D objectss clip plane will be activated\de-activated..
Return Value
None
Errors
actor should be valid
Description
This routine activate/de-activate the clip plane for an actor which is specified by actor.If actor is None, all the 3D objectss clip plane will be activated/de-activated. active indicated activation\de-activation. For example,
vis.activeClipPlane( active = False )
Version 1.8
236
3D Plot Functions
Time step Functions
6.11 Time step Functions


getNSteps() getSteps() getTimes() setStep() setStepId()
Return the number of time steps Return the list of time steps Return the list of times Set the current time step Set the current time step id
Version 1.8
237
3D Plot Functions
getNSteps( )
6.11.1 getNSteps( )
Return the number of time steps
Usage
nSteps = vis.getNSteps( )
Input Arguments
None
Return Value
nSteps Number of time steps Integer
Errors
None
Description
This routine returns the number of time steps.For example,
nSteps = vis.getNSteps( )
Version 1.8
238
3D Plot Functions
getSteps( )
6.11.2 getSteps( )
Return the list of time steps
Usage
steps = vis.getSteps( )
Input Arguments
None
Return Value
steps List of time steps List
Errors
None
Description
This routine returns the list of time steps. For example,
steps = vis.getSteps( )
Version 1.8
239
3D Plot Functions
getTimes( )
6.11.3 getTimes( )
Return the list of times
Usage
times = vis.getTimes( )
Input Arguments
None
Return Value
times List of tims List
Errors
None
Description
This routine returns the list of times. For example,
times = vis.getTimes( )
Version 1.8
240
3D Plot Functions
setStep( )
6.11.4 setStep( )
Set the current time step
Usage
vis.setStep( step )
Input Arguments
step The time step which should be set String
Return Value
None
Errors
step should be valid
Description
This routine sets the current time step to step. For example,
vis.setStep( "2" )
Version 1.8
241
3D Plot Functions
setStepId( )
6.11.5 setStepId( )
Set the current time step id
Usage
vis.setStepId( stepId )
Input Arguments
stepId The time step id which should be set Integer
Return Value
None
Errors
stepId should be valid
Description
This routine sets the current time step id to stepId. For example,
vis.setStepId( 3 )
Version 1.8
242
3D Plot Functions
Display Orientation Functions
6.12 Display Orientation Functions


home() fit() snap() snapz() alignDir() rotate() zoom()
Set the camera to its home position Set the camera to fit all the actors in the Scene Graph Compute and aligns the camera to closest principal axis Compute and aligns the camera to closest z plane Set the camera to look up in a special direction Rotate the camera by special degrees Zoom the camera by special scale
Version 1.8
243
3D Plot Functions
home( )
6.12.1 home( )
Set the camera to its home position
Usage
vis.home( )
Input Arguments
None
Return Value
None
Errors
None
Description
This routine sets the camera to its home position. For example,
vis.home( )
Version 1.8
244
3D Plot Functions
fit( )
6.12.2 fit( )
Set the camera to fit all the actors in the Scene Graph
Usage
vis.fit( )
Input Arguments
None
Return Value
None
Errors
None
Description
This routine sets the camera to fit all the actors in the Scene Graph. For example,
vis.fit( )
Version 1.8
245
3D Plot Functions
snap( )
6.12.3 snap( )
Compute and align the camera to closest principal axis
Usage
vis.snap( )
Input Arguments
None
Return Value
None
Errors
None
Description
This routine compute and align the camera to closest principal axis. For example,
vis.snap( )
Version 1.8
246
3D Plot Functions
snapz( )
6.12.4 snapz( )
Compute and align the camera to closest z plane
Usage
vis.snapz( )
Input Arguments
None
Return Value
None
Errors
None
Description
This routine compute and align the camera to closest z plane. For example,
vis.snapz( )
Version 1.8
247
3D Plot Functions
alignDir( )
6.12.5 alignDir( )
Set the camera to look up in a special direction
Usage
vis.alignDir( dir )
Input Arguments
dir String The desired direction.Valid values are : 'x+', '+x', 'xplus', 'y+', '+y', 'yplus', 'z+', '+z', 'zplus', 'x-', '-x', 'xminus', 'y-', '-y', 'yminus', 'z-', '-z', 'zminus' in case insensitive manor
Return Value
None
Errors
dir should be valid
Description
This routine sets the camera to look up in a special direction specified by dir. For example,
vis.alignDir( dir = 'y-' )
Version 1.8
248
3D Plot Functions
rotate( )
6.12.6 rotate( )
Rotate the camera by special degrees in special direction
Usage
vis.rotate( dir, angle = 45 )
Input Arguments
dir String The desired direction.Valid values are : 'x+', '+x', 'xplus', 'y+', '+y', 'yplus', 'z+', '+z', 'zplus', 'x-', '-x', 'xminus', 'y-', '-y', 'yminus', 'z-', '-z', 'zminus' in case insensitive manor angle Degree of rotation Integer
Return Value
None
Errors

dir should be valid angle should be integer
Description
This routine rotates the camera by special degrees given by angle in special direction given by dir. For example,
vis.rotate( dir ="x+", angle = -20. )
Version 1.8
249
3D Plot Functions
zoom( )
6.12.7 zoom( )
Zoom the camera by special scale
Usage
vis.zoom( scale = 1. )
Input Arguments
scale Zoom scale Integer
Return Value
None
Errors
scale should be integer
Description
This routine zoom the camera by special scale given by scale . For example,
vis.zoom( 5 )
Version 1.8
250
3D Plot Functions
Add\Remove Actors Functions
6.13 Add\Remove Actors Functions


addTxtActor() remTxtActor() addImgActor() remImgActor() addSphereActor() delSphereActor() addCmapLegendActor() delCmapLegendActor() addGeomActor() delGeomActor()
Add a 2D text actor to the scene graph Remove 2D text actor from the scene graph Add an image actor to the scene graph Remove image actor from the scene graph Add a sphere actor to the scene graph Remove sphere actor from the scene graph Add 2D color map legend at a specified location of scene graph Remove color map legend from the scene graph Add a geom actor to the scene graph Remove geom actor from the scene graph
Version 1.8
251
3D Plot Functions
addTxtActor( )
6.13.1 addTxtActor( )
Add a 2D text actor to the scene graph.
Usage
txtActor = vis.addTxtActor( text position style fontSize color horAlignment verAlignment = = = = = = = "ACUSIM", [0.5,0.5], "Times New Roman:bold", 12, [1,0,0], "CENTER", "BOTTOM" )
Input Arguments
text Annotation text position Annotation position style Annotation style fontSize Annotation font size color Annotation color horAlignment String List Integer String List String
Annotation horizontal alignmentValid values are : "RIGHT", "CENTER" and "LEFT" verAlignment String
Version 1.8
252
3D Plot Functions
addTxtActor( )
Annotation vertical alignment. Valid values are : "BOTTOM", "TOP" and "HALF"
Return Value
txtActor The 2D text actor Object
Errors
None
Description
This routine adds a 2D text actor to the scene graph. For example,
txtActor = vis.addTxtActor( text = 'Test', color = [0,0,1], fontSize = 20
Version 1.8
253
3D Plot Functions
remTxtActor( )
6.13.2 remTxtActor( )
Remove 2D text actor from the scene graph
Usage
vis.remTxtActor( txtActor )
Input Arguments
txtActor The text actor which should be removed Object
Return Value
None
Errors
txtActor must exist
Description
This routine removes 2D text actor from the scene graph. For example,
vis.remTxtActor( txtActor )
Version 1.8
254
3D Plot Functions
addImgActor( )
6.13.3 addImgActor( )
Add an image actor to the scene graph.
Usage
imgActor = vis.addImgActor( filename image position width height horAlignment verAlignment = = = = = = = None, None, [0.5,0.5], -1, -1, "CENTER", "BOTTOM" )
Input Arguments
fileName Image file name image Image to be added position Image actor position width Image width height Image height horAlignment String Integer Integer List String String
Image horizontal alignment. Valid values are : "RIGHT", "CENTER" and "LEFT" verAlignment String
Image vertical alignment. Valid values are : "BOTTOM", "TOP" and "HALF"
Version 1.8
255
3D Plot Functions
addImgActor( )
Return Value
imgActor The image actor Object
Errors
None
Description
This routine adds an image actor to the scene graph. For example,
imgActor = vis.addImgActor( filename position width height = = = = "logo_med.jpg", [0.73,0.78,0.5], 300 , 60 )
Version 1.8
256
3D Plot Functions
remImgActor( )
6.13.4 remImgActor( )
Remove image actor from the scene graph
Usage
vis.remImgActor( imgActor )
Input Arguments
imgActor The image actor which should be removed Object
Return Value
None
Errors
imgActor must exist
Description
This routine removes image actor from the scene graph. For example,
vis.remImgActor( imgActor )
Version 1.8
257
3D Plot Functions
addSphereActor( )
6.13.5 addSphereActor( )
Add a sphere actor to the scene graph
Usage
sphActor = vis.addSphereActor( center color pointSize fontSize trans = = = = = [0,0,0], [0,1,0], 2, None, False, radius text lineWidth vis transVal = = = = = None, None, 2, True, 0.5
Input Arguments
center Center of the sphere radius Sphere radius color Sphere color text Sphere text pointSize Sphere point size lineWidth Sphere line width fontSize Sphere text font size vis Boolean Integer Integer Integer String List( of RGB ) Real Array
Version 1.8
258
3D Plot Functions
addSphereActor( )
Sphere visibility trans Sphere transparency transVal Sphere transparency value Integer Boolean
Return Value
sphereActor The sphere actor Object
Errors
None
Description
This routine adds a sphere actor to the scene graph. For example,
sphActor = vis.addSphereActor( radius = 3 )
Version 1.8
259
3D Plot Functions
delSphereActor( )
6.13.6 delSphereActor( )
Remove sphere actor from the scene graph
Usage
vis.delSphereActor( sphActor )
Input Arguments
sphActor The sphere actor which should be removed Object
Return Value
None
Errors
sphActor must exist
Description
This routine removes sphere actor from the scene graph. For example,
vis.delSphereActor( sphActor )
Version 1.8
260
3D Plot Functions
addCmapLegendActor( )
6.13.7 addCmapLegendActor( )
Add 2D color map legend to a specified location of scene graph
Usage
cmapActor = vis.addCmapLegendActor( text textFont minVal maxVal nVals valFont xpos ypos xsize ysize = = = = = = = = = = "Color Map Legend", "Times-Roman", 0, 5, 3, "Times-Roman", 0.05, 0.15, 2, 10
Input Arguments
text Colormap text which is shown on top of legend textFont Colormap text font minVal Colormap minimum value maxVal Colormap maximum value nVals Number of values in colormap valFont Colormap values font String Integer Integer Integer String String
Version 1.8
261
3D Plot Functions
addCmapLegendActor( )
xpos Colormap X position
Real
ypos Colormap Y position
Real
xsize Colormap X size
Integer
ysize Colormap Y size
Integer
Return Value
cmapActor The color map legend actor Object
Errors
None
Description
This routine adds 2D color map legend to a specified location of scene graph. For example,
cmap = vis.addCmapLegendActor( text minVal maxVal nVals xpos = = = = = "Pressure", 0, 4, 4, 0.08
Version 1.8
262
3D Plot Functions
delCmapLegendActor( )
6.13.8 delCmapLegendActor( )
Remove color map legend from the scene graph
Usage
vis.delCmapLegendActor( cmapActor )
Input Arguments
cmapActor The cmap actor which should be removed Object
Return Value
None
Errors
cmapActor must exist
Description
This routine removes color map legend actor from the scene graph. For example,
vis.delCmapLegendActor( cmapActor )
Version 1.8
263
3D Plot Functions
addGeomActor( )
6.13.9 addGeomActor( )
Add a geom actor to the scene graph
Usage
geomActor = vis.addGeomActor( type = "cylinder", normal = [0,1,0], normalY = [0,1,0], radius = None, width = None, xangle = None, zangle = None, point = None, point1 = None, text = None, lineWidth = 2, arrowLength= None, tetSize = None, trans = False, points = None center normalX normalZ height depth yangle color pntList point2 pointSize fontSize triSize vis transVal = = = = = = = = = = = = = = [0,0,0], [1,0,0], [0,0,1], None, None, None, [1,0,0], None, None, 2, None, None, True, 0.5, )
Input Arguments
type String Type of the geom actor. It could be "cylinder", "cone", "box", "sphere", "tet", "triangle", "circle", "brick", "text" or "quade" center Center of the geom actor normal Geom normal vector normalX Geom normalX Array Array Array
Version 1.8
264
3D Plot Functions
addGeomActor( )
normalY Geom normalY
Array
normalZ Geom normalZ
Array
radius Geom radius
Real
height Geom height
Real
width Geom width
Real
depth Geom depth
Real
xangle Geom xangle
Real
yangle Geom yangle
Real
zangle Geom zangle
Real
color Geom color
List( of RGB )
point Geom point
Array
pntList Geom point list
List
point1
Array
Version 1.8
265
3D Plot Functions
addGeomActor( )
Geom first point point2 Geom second point text Geom text pointSize Geom point size lineWidth Geom line width fontSize Geom text font size arrowLength Geom arrow length triSize Geom triangle Size tetSize Geom tet size vis Geom visibility trans Geom transparency transVal Geom transparency value points Geom points Array Integer Boolean Boolean Integer Integer Integer Integer Integer Integer String Array
Version 1.8
266
3D Plot Functions
addGeomActor( )
Return Value
geomActor The geom actor Object
Errors
None
Description
This routine adds a geom actor to the scene graph. For example,
geomActor = vis.addGeomActor( type = cylinder, radius = 3 )
Version 1.8
267
3D Plot Functions
delGeomActor( )
6.13.10 delGeomActor( )
Remove geom actor from the scene graph
Usage
vis.delGeomActor( geomActor )
Input Arguments
geomActor The geom actor which should be removed Object
Return Value
None
Errors
geomActor must exist
Description
This routine removes geom actor from the scene graph. For example,
vis.delGeomActor( geomActor )
Version 1.8
268
3D Plot Functions
Set\get actors properties
6.14 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 or get through the following functions. These are the support functions documented in this section:

display() transparency() transparencyVal() color() setVisibility() lineWidth() pointSize()
Set\get display type of an actor Set\get transparency on\off of an actor Set\get transparency value of an actor Set\get transparency color of an actor Set Visibility of an actor Set\get the line width of an actor Set\get the point size of an actor
Version 1.8
269
3D Plot Functions
display( )
6.14.1 display( )
Set\get display type of an actor
Usage
actor.display( displayType = None )
Input Arguments
displayType String Display type. Valid values are : "outline", "solid", "wireframe", "contour", "velocity_vector", "none"
Return Value
If displayType = None,the current display type will be returned, else None. String
Errors
displayType must be valid
Description
This routine set\get display type of an actor. If displayType is None, the current display type will be returned. For example,
fan = vis.getSrfActor( fan.display( or: fanDisType = fan.display( ) "impeller" 'solid_wire' ) )
Version 1.8
270
3D Plot Functions
transparency( )
6.14.2 transparency( )
Set\get transparency on/off of an actor
Usage
actor.transparency( trans = None )
Input Arguments
trans Transparency on/off flag Boolean
Return Value
If trans = None,the current transparency flag will be returned, else None. Boolean
Errors
trans must be Boolean
Description
This routine set\get transparency on/off of an actor. If trans is None, the current transparency flag will be returned.For example,
fan = vis.getSrfActor( fan.transparency( or: fanTrans = fan.transparency( ) "impeller" True ) )
Version 1.8
271
3D Plot Functions
transparencyVal( )
6.14.3 transparencyVal( )
Set\get transparency value of an actor
Usage
actor.transparencyVal( transVal = None )
Input Arguments
transVal Transparency value Integer
Return Value
If transVal = None,the current transparency value will be returned, else None. Integer
Errors
transVal must be integer
Description
This routine set\get transparency value of an actor. If transVal is None, the current transparency value will be returned.For example,
fan = vis.getSrfActor( fan.transparencyVal( or: fanTransVal = fan.transparencyVal( ) "impeller" 2 ) )
Version 1.8
272
3D Plot Functions
color( )
6.14.4 color( )
Set\get color of an actor
Usage
actor.color( red = None, green = None, blue = None )
Input Arguments
red Transparency value green Transparency value blue Transparency value Real Real Real
Return Value
If red = None and green = None and blue = None ,the current RGB value will be returned, else None. List( of RGB )
Errors
red, green and blue must be Real values.
Description
This routine set\get color value of an actor.If red, green and blue are None, the current red, green and blue values of color will be returned. For example,
Version 1.8
273
3D Plot Functions
color( )
fan = vis.getSrfActor( "impeller" fan.color( 0.5, 1, 0.4 or : fanColor = fan.color(
) )
Version 1.8
274
3D Plot Functions
setVisibility( )
6.14.5 setVisibility( )
Set the visibility of an actor
Usage
actor.setVisibility( visibility = on )
Input Arguments
visibility Visibility value String
Return Value
None
Errors
visibility must be on or off
Description
This routine sets visibility value of an actor. For example,
fan = vis.getSrfActor( fan.setVisibility( "impeller" "off" ) )
Version 1.8
275
3D Plot Functions
lineWidth( )
6.14.6 lineWidth( )
Set\get line width of an actor
Usage
actor.lineWidth( width = None )
Input Arguments
width Line width of an actor Integer
Return Value
If width = None,the current width value will be returned, else None. Integer
Errors
width must be integer
Description
This routine set\get line width value of an actor.If width is None, the current line width value will be returned. For example,
fan = vis.getSrfActor( fan.lineWidth( or : fanLineWdt = fan.lineWidth( ) "impeller" 3 ) )
Version 1.8
276
3D Plot Functions
pointSize( )
6.14.7 pointSize( )
Set\get point size of an actor
Usage
actor.pointSize( size = None )
Input Arguments
size Point size of an actor Integer
Return Value
If size = None,the current size value will be returned, else None. Integer
Errors
size must be integer
Description
This routine set\get size value of an actor.If size is None, the current point size value will be returned. For example,
fan = vis.getSrfActor( fan.pointSize( or : fanPntSize = fan.pointSize( ) "impeller" 2 ) )
Version 1.8
277
3D Plot Functions
Scene graph Functions
6.15 Scene graph Functions


saveImage() setBgColor() setAxis() setLineWidth() setShading() setPointSize() setTransType() bndBox()
Create and save an image of the screen Set background color of the scene graph Set axis size of the scene graph Set the line width used in various actors of scene graph Set the shading style used in various actors of scene graph Set the point size used in various actors of scene graph Set the transparency type of scene graph Return the bounding box of the scene graph
Version 1.8
278
3D Plot Functions
saveImage( )
6.15.1 saveImage( )
Create and save an image of the screen
Usage
savedFileName = vis.saveImage( width = fileName = dirName = 600, height = None, fileType = , 400, png, )
Input Arguments
width Width of image height Height of image fileName Image file name fileType String String Integer Integer
Image file type. Supported formats are: .png, .gif, .jpg, .ps, .iv, and .vrml dirName The directory that image will be saved in it String
Return Value
savedFileName Saved image file name String
Version 1.8
279
3D Plot Functions
saveImage( )
Errors
None
Description
This routine creates and saves an image of the screen and returns the image fileName; If fileName argument is given, it is used and fileType is ignored. Otherwise, fileType is used to build a unique file name. For example,
fname = vis.saveImage( width=600, height=400 )
Version 1.8
280
3D Plot Functions
setBgColor( )
6.15.2 setBgColor( )
Set background color of the scene graph
Usage
vis.setBgColor( color )
Input Arguments
color Background color which should be set List( of RGB )
Return Value
None
Errors
None
Description
This routine sets background color of the scene graph to color. For example,
vis.setBgColor( color = (1,1,1) )
Version 1.8
281
3D Plot Functions
setAxis( )
6.15.3 setAxis( )
Set axis size of the scene graph
Usage
vis.setAxis( size = None )
Input Arguments
size Axis size which should be set Integer
Return Value
None
Errors
None
Description
This routine sets axis size of the scene graph to size. For example,
vis.setAxis( 3 )
Version 1.8
282
3D Plot Functions
setLineWidth( )
6.15.4 setLineWidth( )
Set the line width used in various actors of scene graph
Usage
vis.setLineWidth( width = None )
Input Arguments
width The line width which should be set Integer
Return Value
None
Errors
None
Description
This routine sets the line width used in various actors of scene graph to width. For example,
vis.setLineWidth( 2 )
Version 1.8
283
3D Plot Functions
setShading( )
6.15.5 setShading( )
Set the shading style used in various actors of scene graph.
Usage
vis.setShading( shading = None )
Input Arguments
shading String The shading style which should be set. Valid values are : 'Flat', 'Gouraud', 'Phong'
Return Value
None
Errors
None
Description
This routine sets the shading style used in various actors of scene graph to shading. For example,
vis.setShading( 'Gouraud' )
Version 1.8
284
3D Plot Functions
setPointSize( )
6.15.6 setPointSize( )
Set the point size used in various actors of scene graph.
Usage
vis.setPointSize( size = None )
Input Arguments
size The point size which should be set Integer
Return Value
None
Errors
None
Description
This routine sets the point size used in various actors of scene graph to size. For example,
vis.setPointSize( 3 )
Version 1.8
285
3D Plot Functions
setTransType( )
6.15.7 setTransType( )
Set the transparency type of scene graph.
Usage
vis.setTransType( type )
Input Arguments
type String Transparency type which should be set. Valid values are: "SCREEN_DOOR", "ADD", "DELAYED_ADD", "BLEND", "SORTED_OBJECT_ADD", "DELAYED_BLEND" and "SORTED_OBJECT_BLEND".
Return Value
None
Errors
type should be valid.
Description
This routine sets the transparency type of scene graph to type. For example,
vis.setTransType( "BLEND" )
Version 1.8
286
3D Plot Functions
bndBox( )
6.15.8 bndBox( )
Return the bounding box of the scene graph.
Usage
bndBox = vis.bndBox( )
Input Arguments
None
Return Value
bndBox Bounding box of the scene graph Array
Errors
None
Description
This routine returns the bounding box of the scene graph. For example,
boundBox = vis.bndBox( )
Version 1.8
287
3D Plot Functions
Miscellaneous Functions
6.16 Miscellaneous Functions


setDeform() toggleLogo()
Turn on/off the deform geometry Toggle the display of Acusim logo
Version 1.8
288
3D Plot Functions
setDeform( )
6.16.1 setDeform( )
Turn on/off the deform geometry.
Usage
vis.setDeform( deform = True )
Input Arguments
deform Deform geometry Boolean
Return Value
None
Errors
None
Description
This routine turns on/off the deform geometry to deform. For example,
vis.setDeform( True )
Version 1.8
289
3D Plot Functions
toggleLogo( )
6.16.2 toggleLogo( )
Toggle the display of Acusim logo.
Usage
vis.toggleLogo( )
Input Arguments
None
Return Value
None
Errors
None
Description
This routine toggles the display of Acusim logo. For example,
vis.toggleLogo( )
Version 1.8
290
3D Plot Functions
setCmap( )
6.16.3 setCmap( )
Set color map.
Usage
vis.setCmap( cmap = 'default' )
Input Arguments
cmap The color map which is set NumArray or name of it as String
Return Value
None
Errors
None
Description
This routine set the color map for colour contour. For example,
vis.setCmap( )
Version 1.8
291
Exhibit A. Basic Latex Tags
Exhibit A.Basic Latex Tags

These are some useful tags in latex formatting system:

\centering \vfill \hfill \vspace \hspace \vline \hline \newpage \clearpage \dotfill \section{text} \subsection{text} \subsubsection{text} \ref{text} \label{text} \emph{text} \textrm{text} \textsf{text} \texttt{text} \textup{text} \textit{text} \textsl{text} \textbf{text} \textsc{text} \textmd{text} \uline{text} \uwave{text}
Push contents to the center of the page Add vertical space up to the end of the page Add horizontal space up to the end of the line Add vertical space Add horizontal space Add vertical line Add horizontal line Start a new page Clear page content Fill with dots Add text to a new section Add text to a new subsection Add text to a new sub-subsection Put a reference in the paragraph Add label to image, table, or equation for further reference Write the text in emphasis shape Write the text in roman font family Write the text in sans serif font family Write the text in teletype font family Write the text in upright shape Write the text in italic shape Write the text in slanted shape Write the text in bold shape Write the text in small capitals Write the text in medium weight Write the text in with underline Write the text in with wavy underline
Version 1.8
292
\sout{text} \cite \tiny{text} \scriptsize{text} \footnotesize{text} \small{text} \normalsize{text} \large{text} \Large{text} \LARGE{text} \huge{text} \Huge{text} $eqn$ \backslash ^ _ \\ \<space> \@ \, \; \: \! \> \< \|
Write the text in with strike-out line Write the text in cited shape Write the text in 6pt Write the text in 8pt Write the text in 10pt Write the text in 11pt Write the text in 12pt Write the text in 14pt Write the text in 17pt Write the text in 20pt Write the text in 25pt Write the text in 25pt Write an equation Backslash Superscript (such as AcuSolve^{TM} = AcuSolveTM) Subscript (such as $x_i$ = xi) Start new line Force ordinary space Following period ends sentence Thin space Thick space, math mode Medium space, math mode Negative thin space, math mode Tab Back tab Double vertical lines, math mode
Note that Python interprets "\" as escape character. If you simply want to pass this to a function (such as require for the above LaTeX controls), you must either prefix it with another "\", such as "\\newpage", or use raw Python string, such as r"\newpage".
Version 1.8
293
The following characters have special meaning in text: # $ % & ~ _ ^ \ { }. To write back slash ( \ ), use "\\textbackslash" and to write tilde ( ~ ), use "$\\sim$". Add a "\\" before any other character, if you simply want the character to be written:
$ %
& ~
_ ^
\ { }
The number (pound) sign is used to define use of arguments, for example, in the \newcommand command The dollar sign is used to delineate math and displaymath Enviroments. The percent sign is used to insert Comments in the input file, and to allow line breaks without generating a space. The ampersand is used to separate items in the array and tabular Enviroments. The tilde generates a nonbreaking space To create a tilde in the output, use \verb or the verbatim environment (or cheat by using \~{}, i.e., placing a tilde accent over a "blank" letter). The underscore is used to create subscripts. The carat (circumflex) symbol generates superscripts. To create a carat in the output use \verb or the verbatim environment. The backslash and braces are used in command definitions, for enclosing command arguments, and for delimiting scopes of declarations.
Version 1.8
294
Exhibit B. Acupu Functions
Exhibit B.Acupu Functions

These are the functions of Acupu.dll module:

appendCrds() array2Str() cksumArray() cksumFile() crdOrg() cs2Str() decryptStr() dupNodeMap() elmGradField() elmVolume() encryptStr() getCnnNodes() getFileCnts() getInvMap() getMemoryUsage() getProcIds() getSipVoidPtrInt() getSrfEdge() getSrfSplit() getVolSrf() invMap() licIsAltair() mapPbcFaces() mergeCrds()
Append a new coordinate/usrIds to the end of an old set Convert an array to string for printing Get an array cksum Get file cksum value Get the center of a set of nodes Convert a clean string to a string Decrypt a string Retun a nodal map for duplicate nodes Get the average grad-field within each element Get the volume of each element Encrypt a string Get a unique list of nodes in a connectivity array Get file counts Build and return an inverse map from user number to 0 based index Get memory usage (from first import acupu) Get all process Ids on the system Get an integer from a voidPtr Extract the external/feature edges of an surface set Split a surface based on angle Extract the external surfaces (quad and triangular faces) of an element set. Map an integer or an array of integers from user to 0 based index Is this an Altair license? Map the faces based on periodicity type Merge a new coordinate/usrIds with an old set
AcuReport Reference Manual 295
Version 1.8
nodalVolume() orientSrf() pyt2Str() readArrays() readNastran() readStl() setProgName() srf2Tri() srfLayOut() srfNodalNorm() str2Array() str2Cs() str2Pyt() usrMap() volLayOut() writeArrays() writeEnsightArray() writeStl()
Get the volume associated with each node Reorient the surface connectivity according to the interior elements Convert a clean string to a string Read a file into a set of arrays defined by format Read a Nastran file Read an STL file Set program name for internal messages Convert a surface to triangle Get a set of surface layout information Compute the normal directions for the nodes of surface sets Convert a string to array Convert a string to clean string Convert a string to clean string Map an integer or an array of integers from 0 based index to user Ids Get a set of volume layout information Write arrays in a file Write arrays into EnSight array format Write an STL file
Version 1.8
296
appendCrds( )
B.1 appendCrds( )
Append a new coordinate/usrIds to the end of an old set also return an inverse map from the new usrIds to the extended vector.
Input Arguments
newUsrIds An array of new user indices newCrd An array of new coordinates oldUsrIds An array of old user indices oldCrd An array of old coordinates Array Array Array Array
Return Value
usrIds New user indice crd New coordinates newInvMap Inverse map from new usrIds to new 0 based index Array Array Array
Version 1.8
297
array2Str( )
B.2 array2Str( )
Convert an array to string for printing
Input Arguments
src Source array Array
Return Value
str String representation String
Version 1.8
298
cksumArray( )
B.3 cksumArray( )
Get an array cksum
Input Arguments
src Source array Array
Return Value
cksum Array ckecksum Integer
Version 1.8
299
cksumFile( )
B.4 cksumFile( )
Get file cksum value
Input Arguments
fileName The file name String
Return Value
cksum File's cksum Integer
Version 1.8
300
crdOrg( )
B.5 crdOrg( )
Get the center of a set of nodes
Input Arguments
src Coordinates cnn List of connectivity nodes (optional) Array Array
Return Value
org Center Array
Version 1.8
301
cs2Str( )
B.6 cs2Str( )
Convert a clean string to a string
Input Arguments
src Source string String
Return Value
dst Converted string String
Version 1.8
302
decryptStr( )
B.7 decryptStr( )
Decrypt a string
Input Arguments
src Encrypted string String
Return Value
dst Destination string String
Version 1.8
303
dupNodeMap( )
B.8 dupNodeMap( )
Return a nodal map for duplicate nodes
Input Arguments
crd An array of nodal coordinates tol Distance tolerance to consider duplicate node Integer Array
Return Value
map Map to duplicate nodes Array
Version 1.8
304
elmGradField( )
B.9 elmGradField( )
Get the average grad-field within each element
Input Arguments
crd An array of nodal coordinates cnn An array of surface connectivity vec An array of nodal solution Array Array Array
Return Value
gradVec An array of element gradients Array
Version 1.8
305
elmVolume( )
B.10 elmVolume( )
Get the volume of each element
Input Arguments
crd An array of nodal coordinates cnn An array of surface connectivity Array Array
Return Value
volume An array of element volumes Array
Version 1.8
306
encryptStr( )
B.11 encryptStr( )
Encrypt a string
Input Arguments
Return Value
dst Encrypted string String
Version 1.8
307
getCnnNodes( )
B.12 getCnnNodes( )
Get a unique list of nodes in a connectivity array
Input Arguments
cnn An array of connectivity Array
Return Value
nbc Unique set of nodes in cnn Array
Version 1.8
308
getFileCnts( )
B.13 getFileCnts( )
Get file counts
Input Arguments
fileName The file name String
Return Value
nLines Number of lines (rows) in the file minCols Min number of columns of the lines maxCols Max number of columns of the lines minWidth Min number of chars of the lines maxWidth Max number of chars of the lines size Total size (in number of chars) Integer Integer Integer Integer Integer Integer
Version 1.8
309
getInvMap( )
B.14 getInvMap( )
Build and return an inverse map from user number to 0 based index
Input Arguments
usrIds A 1D array of user numbers Array
Return Value
invMap A 2xn array of inverse map Array
Version 1.8
310
getMemoryUsage( )
B.15 getMemoryUsage( )
Get memory usage (from first import acupu)
Input Arguments
None
Return Value
usage Heap memory usage in chars Integer
Version 1.8
311
getProcIds( )
B.16 getProcIds( )
Get all process Ids on the system
Input Arguments
None
Return Value
procIds An array of pid (process Id) and ppid (parent pid) Array
Version 1.8
312
getSipVoidPtrInt( )
B.17 getSipVoidPtrInt( )
Get an integer from a voidPtr
Input Arguments
obj Sip.voidPtr object fmt Format (combination of "vdi" for void/double/int) String Object
Return Value
val Return value Integer
Version 1.8
313
getSrfEdge( )
B.18 getSrfEdge( )
Extract the external/feature edges of an surface set
Input Arguments
crd Coordinates angle Feature angle cnns List of surface connectivity Array Real Array
Return Value
edges Surface edges Array
Version 1.8
314
getSrfSplit( )
B.19 getSrfSplit( )
Split a surface based on angle
Input Arguments
crd Coordinates cnns Surface connectivity angle Feature angle Real Array Array
Return Value
setIds Array of set Ids Array
Version 1.8
315
getVolSrf( )
B.20 getVolSrf( )
Extract the external surfaces (quad and triangular faces) of an element set
Input Arguments
cnns List of connectivities Array
Return Value
tris Triangular face connectivity quads Quad face connectivity Array Array
Version 1.8
316
invMap( )
B.21 invMap( )
Map an integer or an array of integers from user to 0 based index
Input Arguments
invMap The array returned by getInvMap(usrIds) source An int or 1D/2D array of integers Array or Integer Array
Return Value
destination A maped version of src Array
Version 1.8
317
licIsAltair( )
B.22 licIsAltair( )
Is this an Altair license?
Input Arguments
None
Return Value
altair True if GWU licensing, False otherwise Boolean
Version 1.8
318
mapPbcFaces( )
B.23 mapPbcFaces( )
Map the faces based on periodicity type
Input Arguments
pbcType Pbc type ( "TRANSLATION", "ROTATION") nSrfs Number of faces in each group to be mapped areas1 A 1D array of source face areas areas2 A 1D array of destination face areas ctrs1 A 1D array of source face centers ctrs2 A 1D array of destination face centers trans A 1D array of translation vector (size 3) axis_pt1 A 1D array of the first point on the axis of rotation axis_pt2 A 1D array of the second point on the axis of rotation angle Real Array Array Array Array Array Array Array Integer String
Rotation angle (radians) to go from source to destination face
Version 1.8
319
mapPbcFaces( )
tolerance Allowed tolerance while mapping the face, default = 1e
Real
Return Value
pbcMap PBC map Array
Version 1.8
320
mergeCrds( )
B.24 mergeCrds( )
Merge a new coordinate/usrIds with an old set.Also return an inverse map from the new usrIds to the extended vector. Merging is performed purely on usrIds. Any node in the new set with the same usrIds in the old array is mapped to the old set.
Input Arguments
newUsrIds An array of new user indices newCrd An array of new coordinates oldUsrIds An array of old user indices oldCrd An array of old coordinates Array Array Array Array
Return Value
usrIds New user indices crd New coordinates Array Array
Version 1.8
321
nodalVolume( )
B.25 nodalVolume( )
Get the volume associated with each node.
Input Arguments
Return Value
volume An array of nodal volumes Array
Version 1.8
322
orientSrf( )
B.26 orientSrf( )
Reorient the surface connectivity according to the interior elements.
Input Arguments
elemIds An array of surface to element numbers cnn An array of surface connectivity pElemIds An array of parent element set element numbers pCnn An array of parent element set connectivity pInvMap InvMap of pElemIds(optional) Array Array Array Array Array
Return Value
newCnn Reoriented surface connectivity Array
Version 1.8
323
pyt2Str( )
B.27 pyt2Str( )
Convert a clean string to a string.
Input Arguments
Return Value
dst Converted string String
Version 1.8
324
readArrays( )
B.28 readArrays( )
Read a file into a set of arrays defined by format.
Input Arguments
fileName The file name format Tuple String
A tuple which tells the arrays information. Examples: (('i',1),('d','*')) or ('d',1)
Return Value
arrays A tuple of arrays Tuple
Version 1.8
325
readNastran( )
B.29 readNastran( )
Read a Nastran file.
Input Arguments
fileName Nastran file name String
Return Value
usrIds User Ids crd Coordinates srfs List of surfaces ( id, srfIds, cnn ) cnns List of elements ( id, elemIds, cnn ) lines Left-over lines Array List List Array Array
Version 1.8
326
readStl( )
B.30 readStl( )
Read a STL file.
Input Arguments
fileName STL file name tol Search tolerance Integer String
Return Value
usrIds User Ids crd Coordinates srfs List of surfaces ( cnn, name ) List Array Array
Version 1.8
327
setProgName( )
B.31 setProgName( )
Set program name for internal messages.
Input Arguments
name Program name String
Return Value
None
Version 1.8
328
srf2Tri( )
B.32 srf2Tri( )
Convert a surface to triangle.
Input Arguments
crd An array of coordinates cnn An array of surface connectivity Array Array
Return Value
newCnn An array of tri3 surface connectivity Array
Version 1.8
329
srfLayOut( )
B.33 srfLayOut( )
Get a set of surface layout information.
Input Arguments
Return Value
area Total area center Center of the surface normDir Normal direction dir1 Inplane direction 1 dir2 Inplane direction 2 bndBox Bounding box Array Array Array Array Array Integer
Version 1.8
330
srfNodalNorm( )
B.34 srfNodalNorm( )
Compute the normal directions for the nodes of surface sets.
Input Arguments
crd An array of nodal coordinates cnns One or more surface connectivity sets Array Array
Return Value
nodalNormals Nodal normals Array
Version 1.8
331
str2Array( )
B.35 str2Array( )
Convert a string to array.
Input Arguments
src Source string (created by array2Str) String
Return Value
ary Return array Array
Version 1.8
332
str2Cs( )
B.36 str2Cs( )
Convert a string to clean string.
Input Arguments
Return Value
dst Clean string String
Version 1.8
333
str2Pyt( )
B.37 str2Pyt( )
Convert a string to clean string.
Input Arguments
Return Value
dst Clean string String
Version 1.8
334
usrMap( )
B.38 usrMap( )
Map an integer or an array of integers from 0 based index to user Ids.
Input Arguments
usrIds An array of user indices source An int or 1D/2D array of integers Array or Integer Array
Return Value
destination A maped version of src Array
Version 1.8
335
volLayOut( )
B.39 volLayOut( )
Get a set of volume layout information.
Input Arguments
Return Value
volume Total volume center Center of the surface bndBox Bounding box Array Array Integer
Version 1.8
336
writeArrays( )
B.40 writeArrays( )
Write arrays in a file.
Input Arguments
fileName The file name arrays A list of arrays delimiter Column separator, (default=space) ( optional ) mode 'w' for write (default) or 'a' for append String String Array String
Return Value
None
Version 1.8
337
writeEnsightArray( )
B.41 writeEnsightArray( )
Write arrays into EnSight array format.
Input Arguments
fileName EnSight data file format title Title of the data set dataname Name of the data set vec Vector to output usrIds User Ids (opt) binary Binary flag Boolean Array Array String String String
Return Value
None
Version 1.8
338
writeStl( )
B.42 writeStl( )
Write an STL file.
Input Arguments
fileName STL file name crd Coordinates srfs List of surfaces ( cnn, name ) List Array String
Return Value
None
Version 1.8
339
Routine Index
Routine Index
A
Acs( ) activeClipPlane( ) AcuVis( ) Adb( ) addAuthors( ) addBibliography( ) addClipPlane( ) addCmapLegendActor( ) addCPlane( ) addDate( ) addEquation( ) addFigure( ) addGeomActor( ) addImage( ) addImgActor( ) addInlineEquation( ) addIsoLine( ) addIsoSurface( ) addItem( ) addMaterialModel( ) addSection( ) addSimpleBC( ) addSpace( ) addSphereActor( ) addSubSection( ) addSubSubSection( ) addTable( ) addTableOfContent( ) addText( ) addTitle( ) addTufts( ) addTxtActor( ) alignDir( ) appendCrds( ) array2Str( )
B
56 236 178 94 16 17 233 261 215 18 19 20 264 22 255 23 222 209 24 88 25 89 26 258 27 28 29 31 32 34 229 252 248 297 298 35 36 287
beginBullet( ) beginItemize( ) bndBox( )
Version 1.8
340
Routine Index
cksumArray( ) cksumFile( ) close( ) color( ) convertUnit( ) crdOrg( ) cs2Str( ) Curve( )

D
299 300 37 273 38 301 302 49 303 235 263 220 268 214 227 260 231 270 304 305 306 307 39 40 41 245 96 57 59 60 61 308 62 219 218 98 63 64
decryptStr( ) delClipPlane( ) delCmapLegendActor( ) delCplActor( ) delGeomActor( ) delIsoActor( ) delIsoLnActor( ) delSphereActor( ) delTufts( ) display( ) dupNodeMap( )
E
elmGradField( ) elmVolume( ) encryptStr( ) endBullet( ) endItemize( )

F
fillVSpace( ) fit( )
G
get( ) getArray( ) getBool( ) getChildNodes( ) getChildPars( ) getCnnNodes( ) getColor( ) getCplActor( ) getCplName( ) getCpuTimes( ) getDic( ) getDir( )
Version 1.8
341
Routine Index
getElapseTimes( ) getEnum( ) getFile( ) getFileCnts( ) getFileData( ) getFont( ) getInt( ) getInvMap( ) getIsoActor( ) getIsoLnActor( ) getIsoLnName( ) getIsoName( ) getLinIterData( ) getLinIterSteps( ) getLinIterTimes( ) getLinIterValues( ) getLinIterVarIndx( ) getLinIterVarNames( ) getList( ) getMemoryUsage( ) getNbcActor( ) getNbcName( ) getNCpls( ) getNIsoLns( ) getNIsos( ) getNNbcs( ) getNPbcs( ) getNSclrVars( ) getNSrfs( ) getNSteps( ) getNVars( ) getNVecVars( ) getNVols( ) getOeiNameIndx( ) getOeiNames( ) getOeiSteps( ) getOeiTimes( ) getOeiValues( ) getOeiVarNames( ) getOeiVarUnit( ) getOfcNameIndx( ) getOfcNames( ) getOfcSteps( ) getOfcTimes( ) getOfcValues( ) getOfcVarNames( ) getOfcVarUnit( )
99 65 67 309 68 69 70 310 213 226 225 212 100 101 102 103 104 105 71 311 195 194 217 224 211 193 189 200 185 238 197 202 181 106 107 108 109 110 111 112 113 114 115 116 117 118 119
Version 1.8
342
Routine Index
getOhcNameIndx( ) getOhcNames( ) getOhcSteps( ) getOhcTimes( ) getOhcValues( ) getOhcVarNames( ) getOhcVarUnit( ) getOqiNameIndx( ) getOqiNames( ) getOqiSteps( ) getOqiTimes( ) getOqiValues( ) getOqiVarNames( ) getOqiVarUnit( ) getOriNameIndx( ) getOriNames( ) getOriSteps( ) getOriTimes( ) getOriValues( ) getOriVarNames( ) getOriVarUnit( ) getOsiNameIndx getOsiNameIndx( ) getOsiNames( ) getOsiSteps( ) getOsiTimes( ) getOsiValues( ) getOsiVarNames( ) getOsiVarUnit( ) getOthNameIndx( ) getOthNames( ) getOthNodes( ) getOthSteps( ) getOthTimes( ) getOthValues( ) getOthVarNames( ) getOthVarUnit( ) getPar( ) getPasswd( ) getPbcActor( ) getPbcName( ) getPrbDesc( ) getProcIds( ) getReal( ) getRef( ) getRefs( ) getResRatioData( )
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 72 74 191 190 90 312 75 77 78 156
Version 1.8
343
Routine Index
getResRatioSteps( ) 157 getResRatioTimes( ) 158 getResRatioValues( ) 159 getResRatioVarIndx( ) 161 getResRatioVarNames( ) 162 getResRatioVarUnit( ) 163 getSclrVarName( ) 201 getSipVoidPtrInt( ) 313 getSolRatioData( ) 164 getSolRatioSteps( ) 165 getSolRatioTimes( ) 166 getSolRatioValues( ) 167 getSolRatioVarIndx( ) 169 getSolRatioVarNames( ) 170 getSolRatioVarUnit( ) 171 getSrfActor( ) 187 getSrfEdge( ) 314 getSrfName( ) 186 getSrfSplit( ) 315 getSteps( ) 172, 239 getStr( ) 79 getTab( ) 80 getTarea( ) 81 getTimeIncs( ) 173 getTimes( ) 174, 240 getType( ) 82 getVals( ) 84 getVarDim( ) 199 getVarName( ) 198 getVarUnit( ) 175 getVecVarName( ) 203 getVolActor( ) 183 getVolName( ) 182 getVolSrf( ) 316
H
home( )
I
244 317 318 276 319
invMap( )
L
licIsAltair( ) lineWidth( )
M
mapPbcFaces( )
Version 1.8
344
Routine Index
mergeCrds( ) 321 modifyPackageOptions( ) 42

N
newPage( ) nodalVolume( )
O
43 322 323 51 277 324 44 325 326 327 257 254 14 249 279 282 291 289 283 285 328 205 204 284 241 242 286 286 207 206 275 246 247 329 330 331
orientSrf( )
P
Plot2D( ) pointSize( ) pyt2Str( )

R
rawLatex( ) readArrays( ) readNastran( ) readStl( ) remImgActor( ) remTxtActor( ) Report( ) rotate( )

S
saveImage( ) setAxis( ) setCmap( ) setDeform( ) setLineWidth( ) setPointSize( ) setProgName( ) setSclrLimits( ) setSclVar( ) setShading( ) setStep( ) setStepId( ) setTransType setTransType( ) setVecScale( ) setVecVar( ) setVisibility( ) snap( ) snapz( ) srf2Tri( ) srfLayOut( ) srfNodalNorm( )
Version 1.8
345
Routine Index
str2Array( ) str2Cs( ) str2Pyt( )

T
332 333 334 290 271 272 228 335 336 337 338 45 46 47 339 250
toggleLogo( ) transparency( ) transparencyVal( ) Tufts

U
usrMap( )
V
volLayOut( )
W
writeArrays( ) writeEnsightArray( ) writeHtml( ) writePdf( ) writeRtf( ) writeStl( )

Z
zoom( )
Version 1.8
346

AcuReport Reference Manual

Enviado por

Dados do documento

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

AcuReport Reference Manual

Enviado por

Direitos autorais:

Formatos disponíveis

AcuReport