Table of Contents

5. Library Device Interfaces - *Fil,*Lib

The library device interface modules are responsible for reading specific file formats. There are two basic types of interface modules, those that read files containing only geometry tesselation or model information (*Fil) and those that read files which contain both model and results information (*Lib). The library interface modules currently include the following, All *Fil and *Lib modules behave much alike. The functions of the SDRCLib module will be used as representative of all interface modules. The functions for the PatLib and PLOT3DLib modules are discussed separately due to additional functions which are needed for their use.

Table of Contents

5.1 SDRC/IDEAS Universal File - SDRCLib

Universal files may be read from any source as long as they adhere to the format standards published by SDRC (now Siemens). The methods associated with a SDRCLib object are the following.

Instance a SDRCLib object using vdm_SDRCLibBegin. Once instanced set pointers to abstract data functions using vdm_SDRCLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_SDRCLibSetFunction.

The SDRC/IDEAS universal file may be either in a text or a binary format. The binary version of the file currently supports only a limited subset of the complete set of datasets supported by the text version of the file. This subset is specifically designed to support post-processing of finite element simulation results. The SDRCLib module will automatically detect a universal file in text or binary format. Universal files in text format may contain many types of data including finite element, test, geometry, drafting, etc. Currently only finite element related data is recognized contained in the following Universal Dataset numbers:

Supported Dataset Numbers
Dataset Number
Name Description
151
Header Version, time, date
164
Units Physical unit types
15
781
2411
Nodes Node definitions
71
780
2412
Elements Element definitions
18
2420
Coordinate Systems Coordinate systems
436
Colors Colors
752
2417, 2429
2430, 2432, 2435
2452, 2467, 2477
Permanent Groups Node and element sets
790
Loads Load case definition
791
Restraints Restraint case defintion
1710
1714, 1716
Materials Material definition
776
731
772
788, 789
2437, 2448, 2470
Properties Element property definition
55, 56, 57
2414
Results Results data
4001
Stream Boundary condition map for streams
4002
Void Boundary condition map for voids
4003
Zone Boundary condition map for zones

Supported Dataset Numbers, Binary File Format
Dataset Number
Name Description
151
Header Version, time, date
164
Units Physical unit types
2411
Nodes Node definitions
2412
Elements Element definitions
2420
Coordinate Systems Coordinate systems
2435
Permanent Groups Node and element sets
2414
Results Results data
4001
Stream Boundary condition map for streams
4002
Void Boundary condition map for voids
4003
Zone Boundary condition map for zones

Each results dataset is appended with the solution set or load set id, set, and a step number, step. For eigenvalue analysis, the step number is the mode number, for transient analysis, the step number is the time step number. Each results dataset type may be applicable to nodes or elements.

The Stream, Void and Zone datasets result in the creation of element sets and possibly node sets. The element set datasets will have the following possible attributes.

Table of Contents

5.2 Writing SDRC/IDEAS Universal Files

The SDRCLib module also supports the writing of IDEAS ASCII Universal files. Finite element model entities must be contained in a VisTools Model object. The LMan module function vdm_LManSaveModel is used to perform the actual file writing. The file may also be written directly using the Model object function vis_ModelWrite. The interface currently writes the following dataset numbers.

Supported Dataset Numbers
Dataset Number
Name Description
18
Coordinate Systems Coordinate systems
164
Units Physical unit types
2411
Nodes Node definitions
2412
Elements Element definitions
2452
Permanent Groups Node and element sets
751
Multipoint constraints Constraint Sets for Recovery MPCs
790
Loads Load case definition
791
Restraints Restraint case defintion
792
Temperatures Temperature sets
2414
Results Results data

Table of Contents

5.3 Function Descriptions

The currently available SDRCLib functions are described in detail in this section.


Table of Contents , SDRCLib

NAME

*vdm_SDRCLibBegin - create an instance of a SDRCLib object

C SPECIFICATION

vdm_SDRCLib *vdm_SDRCLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created SDRCLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a SDRCLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a SDRCLib object using

     void vdm_SDRCLibEnd (vdm_SDRCLib *sdrclib)

Return the current value of a SDRCLib object error flag using

     Vint vdm_SDRCLibError (vdm_SDRCLib *sdrclib)


Table of Contents , SDRCLib

NAME

vdm_SDRCLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_SDRCLibDataFun (vdm_SDRCLib *sdrclib,
                         vdm_DataFun *datafun);

INPUT ARGUMENTS

sdrclib      Pointer to SDRCLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , SDRCLib

NAME

vdm_SDRCLibAbort - set abort flag

C SPECIFICATION

void vdm_SDRCLibAbort (vdm_SDRCLib *sdrclib)

INPUT ARGUMENTS

sdrclib      Pointer to SDRCLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_SDRCLibSetFunction.


Table of Contents , SDRCLib

NAME

vdm_SDRCLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_SDRCLibSetFunction (vdm_SDRCLib *sdrclib,
                             Vint funtype,
                             void (*function)(vdm_SDRCLib*, Vobject*),
                             Vobject *object)

INPUT ARGUMENTS

sdrclib      Pointer to SDRCLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.4 ABAQUS Input File - ABAFil

The ABAQUS input file is a text file which contains the input description of a finite element model for the ABAQUS finite element program.

The methods associated with a ABAFil object are the following.

Instance a ABAFil object using vdm_ABAFilBegin. Once instanced set pointers to abstract data functions using vdm_ABAFilDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_ABAFilSetFunction.

This interface only produces datasets associated with the finite element model, no results datasets are produced. The element types commonly associated with structural and thermal analysis are supported. The PARTID.E dataset is set to the property id if properties (sections) are defined, otherwise it is set to the count of the element set. Use the VDM_CONVENTION_ALTPART to enable the assignment of part identifiers for each instance rather than properties.

The interface currently recognizes the following input keywords. Node based surfaces when referenced as master surfaces for tie and contact constraints are converted to an element face set internally. Any element face is included in the surface if all of it's nodes are contained in the node based surface.

Supported Keywords
Miscellaneous
Description
*HEADING
Define title string
*INCLUDE
Read from specified file
*PARAMETER
Define a parameter
*PART
*ENDPART
Define a parameter
*INSTANCE
*ENDINSTANCE
Define an instance of a part
*ASSEMBLY
*ENDASSEMBLY
Define an assembly
*PHYSICAL CONSTANTS
Define physical constants
Nodes, Elements
Coordinate Systems
Description
*NODE
Create node. If the NSET parameter is specified a node set will be created
*NSET
Create node set
*NCOPY
*NFILL
*NGEN
Generate nodes.
*NMAP
Node locations are mapped.
*SYSTEM
Node locations are transformed.
*ELEMENT
Create element and element set
*ELSET
Create element set
*ELCOPY
*ELGEN
Generate elements
*ORIENTATION
Define element material system, a coordinate system may be created
*KINEMATIC COUPLING
*COUPLING
*DISTRIBUTING
*KINEMATIC
Define rigid elements
*RELEASE
Define element enpoint moment release
*TRANSFORM
Create coordinate system
Element Properties
Description
*SOLID SECTION
Create solid element property
*SHELL SECTION
*SHELL GENERAL SECTION
Create shell element property
*MEMBRANE SECTION
Create membrane element property
*BEAM SECTION
*BEAM GENERAL SECTION
Create beam element property
*SPRING
*DASHPOT
Create spring dashpot element property
*MASS
*ROTARY INERTIA
Create mass element property
*GAP
Create gap element property
*CENTROID
*SHEAR CENTER
*SECTION POINTS
*TRANSVERSE SHEAR
Define shell or beam element properties
*NODAL THICKNESS
Define shell element nodal thickness
*NORMAL
Define beam element orientation
*DISTRIBUTING COUPLING
Define distributing coupling element property
*USER ELEMENT
Create superelement property
*MATRIX
Material Properties
Description
*MATERIAL
Create a material property.
*DENSITY
*ELASTIC
*EXPANSION
*DAMPING
Define material properties
*CONDUCTIVITY
*LATENT HEAT
*SPECIFIC HEAT
Define heat transfer material properties
Restraints
Description
*BOUNDARY
Create restraint case
*EQUATION
Define multipoint constraint
Contact and Co-simulation
Description
*CONTACT PAIR
Create contact pair case
*CO-SIMULATION
Create co-simulation case
*SURFACE
*SURFACE DEFINITION
Define contact surface geometry
*SURFACE BEHAVIOR
*SURFACE INTERACTION
Define contact surface properties
*TIE
Define tied surface
Loads and Initial Conditions
Description
*AMPLITUDE
Create load case amplitude curve
*CFILM
*CFLUX
*CLOAD
Define concentrated load
*DFLUX
*DSFLUX
*DLOAD
*DSLOAD
Define distributed load
*FILM
*FILM PROPERTY
*RADIATE
Define distributed thermal load
*INITIAL CONDITIONS
Create load case or initial condition case
*TEMPERATURE
Define temperature
Solution and Control
Description
*STEP
*END STEP
Create solution property
*BUCKLE
*DYNAMIC
*FREQUENCY
*HEAT TRANSFER
*STATIC
Define solution type
*EL FILE
*NODE FILE
*EL PRINT
*NODE PRINT
Define output requests

Table of Contents

5.5 Function Descriptions

The currently available ABAFil functions are described in detail in this section.


Table of Contents , ABAFil

NAME

*vdm_ABAFilBegin - create an instance of a ABAFil object

C SPECIFICATION

vdm_ABAFil *vdm_ABAFilBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created ABAFil object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a ABAFil object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a ABAFil object using

     void vdm_ABAFilEnd (vdm_ABAFil *abafil)

Return the current value of a ABAFil object error flag using

     Vint vdm_ABAFilError (vdm_ABAFil *abafil)


Table of Contents , ABAFil

NAME

vdm_ABAFilDataFun - fill DataFun object

C SPECIFICATION

void vdm_ABAFilDataFun (vdm_ABAFil *abafil,
                        vdm_DataFun *datafun);

INPUT ARGUMENTS

abafil       Pointer to ABAFil object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , ABAFil

NAME

vdm_ABAFilAbort - set abort flag

C SPECIFICATION

void vdm_ABAFilAbort (vdm_ABAFil *abafil)

INPUT ARGUMENTS

abafil      Pointer to ABAFil object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_ABAFilSetFunction.


Table of Contents , ABAFil

NAME

vdm_ABAFilSetFunction - set a call back functions

C SPECIFICATION

void vdm_ABAFilSetFunction (vdm_ABAFil *abafil,
                            Vint funtype,
                            void (*function)(vdm_ABAFil*, Vobject*),
                            Vobject *object)

INPUT ARGUMENTS

abafil       Pointer to ABAFil object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL. AQUI

Table of Contents

5.6 Writing ABAQUS input files

The ABAFil module also supports the writing of ABAQUS input files. Finite element model entities must be contained in a VisTools Model object. The LMan module function vdm_LManSaveModel is used to perform the actual file writing. The file may also be written directly using the Model object function vis_ModelWrite. The interface currently writes the following input keywords.

Supported Keywords
Miscellaneous
Description
*HEADING
Define title string
Nodes, Elements
Coordinate Systems
Description
*NODE
Define node
*NSET
Define node set
*ELEMENT
Define element
*ELSET
Define element set
*ORIENTATION
Define element material system
*KINEMATIC
*KINEMATIC COUPLING
Define rigid elements
*TRANSFORM
Define coordinate system
Element Properties
Description
*COHESIVE SECTION
Define cohesive element property
*SOLID SECTION
Define solid element property
*SHELL SECTION
*MEMBRANE SECTION
Define membrane element property
*BEAM GENERAL SECTION
Define beam element property
*SPRING
Define spring element property
*MASS
*ROTARY INERTIA
Define mass element property
*GAP
Define gap element property
*CENTROID
*SHEAR CENTER
*SECTION POINTS
Define shell or beam element properties
*NODAL THICKNESS
Define shell element nodal thickness
*NORMAL
Define beam element orientation
*DISTRIBUTING
*DISTRIBUTING COUPLING
Define distributing coupling element property
Material Properties
Description
*MATERIAL
Create a material property.
*DENSITY
*ELASTIC
*HYPERELASTIC
*FAILSTRESS
*FAILSTRAIN
*EXPANSION
Define material properties
*CONDUCTIVITY
*SPECIFIC HEAT
Define heat transfer material properties
Restraints
Description
*BASE MOTION
*RETAINED NODAL DOFS
*BOUNDARY
Define restraint case
*MPC
*EQUATION
Define multipoint constraint
Contact and Co-simulation
Description
*TIE
*CONTACT PAIR
Define contact pair case
*CO-SIMULATION
Define co-simulation case
*SURFACE
Define surface geometry
*FRICTION
*SURFACE BEHAVIOR
*SURFACE INTERACTION
Define contact surface properties
Loads and Initial Conditions
Description
*CFILM
*CFLUX
*CLOAD
Define concentrated load
*DFLUX
*DSFLUX
*DLOAD
*DSLOAD
Define distributed load
*SFILM
*FILM
Define distributed load
*INITIAL CONDITIONS
Create load case or initial condition case
*TEMPERATURE
Define temperature
Solution and Control
Description
*STEP
*SELECT EIGENMODES
*GLOBAL DAMPING
*MODAL DAMPING
*END STEP
Define solution property
*BUCKLE
*DYNAMIC
*FREQUENCY
*HEAT TRANSFER
*SELECT EIGENMODES
*RETAINED NODAL DOFS
*SUBSTRUCTURE GENERATE
*STEADY STATE DYNAMICS
*STATIC
Define solution type
*CONTACT FILE
*EL FILE
*NODE FILE
*EL PRINT
*NODE PRINT
Define output requests

Table of Contents

5.7 ABAQUS .fil and .odb File Output - ABALib

The ABAQUS .fil file is produced as a result of an execution of the ABAQUS finite element program. The ASCII and binary forms of the file are supported.

The methods associated with a ABALib object are the following.

Instance a ABALib object using vdm_ABALibBegin. Once instanced set pointers to abstract data functions using vdm_ABALibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_ABALibSetFunction.

The ABAQUS .fil consists of finite element model and results data. The PARTID.E dataset is set to the finite element type.

Supported Records, Model
General, Nodes, Elements
Record Key
Record Type Description
1900, 1990
none Element definitions
1901
none Node definitions
1902
none Active degrees of freedom
1921
none ABAQUS Version, etc.
1922
none Heading
1931, 1932
none Node set
1933, 1934
none Element set
1940
none Label cross-reference

Each dataset name in the results data section is appended with the step number, step and increment number, incr.

Supported Records, Results
*NODE FILE
Record Key
Record Type Description Dataset
101
U Displacements, real/imaginary D
102
V Velocities, real/imaginary V
103
A Accelerations, real/imaginary A
104
RF Reaction forces, real/imaginary R
105
EPOT Electrical potential ELEC_POT
106
CF Point loads, real/imaginary XF
107
COORD Coordinates, X
108
POR Pore or acoustic pressure PRES
109
RVF Reaction fluid volume flux VOLUME_FLUX
106
TF Total forces TF
201
NT Temperatures TEMP
204
RFL Reaction flux R_HEAT_FLOW
204
CFL Concentrated flux XF_HEAT_FLOW
*EL FILE
Record Key
Record Type Description Specific Type
2
TEMP Temperatures TEMP
5
SDV Solution-dependent variables SDV
6
VOIDR Void ratio VOID_RATIO
8
COORD Coordinates X
10
NFLUX Nodal flux caused by heat EN_FLUX
11
S Stresses, real/imaginary S
12
SINV Stress invariants S.[VONMISES], S.[TRESCA]
13
SF Section forces and moments SFM
14
ENER Energy densities SE_DENSITY
15
NFORC Nodal forces caused by stress EN_FORC
18
POR Pore or acoustic pressure PRES
19
ELEN Energy summed over element KE, SE
21
E Total strain, real/imaginary E
22
PE Plastic strains E.[PLAST], E.[EQUIV,PLAST]
23
CE Creep strains E.[CREEP], E.[EQUIV,CREEP]
25
EE Total elastic strains E.[ELAST]
27
STH Section thickness THICKNESS
28
HFL Heat flux vector HEAT_FLUX
29
SE Section strains and curvatures SEK
44
CFAILURE Failure measures FAIL_INDEX.[PLY]
62
PHS Stress components, magnitude/phase S
63
RS RMS values of stress components S.[RMS]
65
PHE Strain components, magnitude/phase E
66
RE RMS values of strain components E.[RMS]
73
PEEQ Equivalent plastic strain E.[EQUIV,PLAST]
74
PRESS Mean pressure stress S.[MEANPRES]
74
MISES Mises stress S.[VONMISES]
78
EVOL Whole element volume VOLUME
88
THE Thermal strains E.[THERMAL]
89
LE Logarithmic strains E
90
NE Nominal strains E
91
ER Mechanical strain rates E_RATE
401
SP Principal stresses S.[PRINCIPAL]
402
ALPHAP Principal values of back-stress S.[PRINCIPAL.Back]
403
EP Principal strains E.[PRINCIPAL]
404
NEP Principal nominal strains E.[PRINCIPAL.NOM]
405
LEP Principal logarithmic strains E.[PRINCIPAL.LOG]
*CONTACT FILE
Record Key
Record Type Description Specific Type
1511
CSTRESS Contact tractions PRES.[CONTACT]
1521
CDISP Contact clearance SD

Table of Contents

5.8 Function Descriptions

The currently available ABALib functions are described in detail in this section.


Table of Contents , ABALib

NAME

*vdm_ABALibBegin - create an instance of a ABALib object

C SPECIFICATION

vdm_ABALib *vdm_ABALibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created ABALib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a ABALib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a ABALib object using

     void vdm_ABALibEnd (vdm_ABALib *abalib)

Return the current value of a ABALib object error flag using

     Vint vdm_ABALibError (vdm_ABALib *abalib)


Table of Contents , ABALib

NAME

vdm_ABALibDataFun - fill DataFun object

C SPECIFICATION

void vdm_ABALibDataFun (vdm_ABALib *abalib,
                        vdm_DataFun *datafun);

INPUT ARGUMENTS

abalib       Pointer to ABALib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , ABALib

NAME

vdm_ABALibAbort - set abort flag

C SPECIFICATION

void vdm_ABALibAbort (vdm_ABALib *abalib)

INPUT ARGUMENTS

abalib      Pointer to ABALib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_ABALibSetFunction.


Table of Contents , ABALib

NAME

vdm_ABALibSetFunction - set a call back functions

C SPECIFICATION

void vdm_ABALibSetFunction (vdm_ABALib *abalib,
                            Vint funtype,
                            void (*function)(vdm_ABALib*, Vobject*),
                            Vobject *object)

INPUT ARGUMENTS

abalib       Pointer to ABALib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.9 Writing ABAQUS .fil data files

The ABALib module also supports a limited capability to write finite element model entities and results to ABAQUS .fil data file format. The .fil file is written in binary format. Finite element model entities and results must be contained in VisTools Model and State objects. The LMan module functions vdm_LManSaveModel and vdm_LManSaveState are used to perform the actual file writing. The interface currently writes the following entities on record types. Table of Contents

5.10 ABAQUS .odb Output Data Base

The ABAQUS .odb file is produced as a result of an execution of the ABAQUS finite element program. The ABAQUS .odb consists of finite element model and results data.

The internal .odb file format is changed occasionally and as a result older .odb files may not be able to be read directly by the current .odb interface. Two new methods have been introduced to detect this condition and upgrade the old .odb file to the current .odb format so that it may be opened and accessed. The non standard methods associated with a ABALib object are the following.

After attempting to open an .odb file and encountering an open error, use the function vdm_ABALibGetInteger to query for the an upgrade requirement. If the .odb file may be upgraded, use vdm_ABALibUpgradeOdb to actually upgrade the old .odb file. The upgraded .odb file may then be opened. The PARTID.E dataset is set to the part id. Use the VDM_CONVENTION_ALTPART to enable the assignment of part identifiers for each instance rather than part. Use the convention, VDM_CONVENTION_EIP to generate elemeent integration point results.

Each dataset name in the results data section is appended with the step number, step and increment number, incr.

Supported Records, Results

Node
Record Type
Description Dataset
U
Displacement D
V
Velocity V
A
Accelerations A
COORD
Coordinate X
RF
Reaction Force R
CF
Point Loads XF
TF
Total Forces TF
NT
NT11
Temperature TEMP
RFL
RFL11
Reaction heat flow R_HEAT_FLOW
CFL
CFL11
Applied heat flow XF_HEAT_FLOW
EPOT
Electric potential ELEC_POT
Element
Record Type
Description Dataset Root
S
Stress S
E
Strain E
SF
Section force and moment SFM
SE
Section strain, curvature SEK
EE
Elastic strain E.[ELAST]
PE
Plastic strain E.[PLAST]
CE
Creep strain E.[CREEP]
PEEQ
Equivalent plastic strain E.[EQUIV,PLAST]
CEEQ
Equivalent creep strain E.[EQUIV,CREEP]
THE
Thermal strain E.[THERMAL]
MISES
VonMises stress S.[VONMISES]
TRESCA
Tresca stress S.[TRESCA]
PRESS
Mean pressure S.[MEANPRES]
STH
Section thickness THICKNESS
HFL
Heat flux HEAT_FLUX
EFLX
Electric flux ELEC_FLUX
ELSE
Strain energy SE
ELKE
Kinetic energy KE
EVOL
Volume VOLUME
ESEDEN
Strain energy density SE_DENSITY
EKEDEN
Kinetic energy density KE_DENSITY
NFORC1
Element force EN_FORC
NFLUX1
Element flux EN_FLUX

Table of Contents

5.11 Function Descriptions

The non standard ABALib functions are described in detail in this section.


Table of Contents , ABALib

NAME

vdm_ABALibGetInteger - test for upgrade required

C SPECIFICATION

void vdm_ABALibGetInteger (vdm_ABALib *abalib,
                           Vint type,
                           Vint param[])

INPUT ARGUMENTS

abalib       Pointer to ABALib object.
type         Type of integer information to query
             =ABALIB_UPGRADEODB      Upgrade .odb required

OUTPUT ARGUMENTS

param        Returned integer information

ERRORS

SYS_ERROR_ENUM is generated if an improper type is specified.

DESCRIPTION

Query for integer information. The integer query ABAFIL_UPGRADEODB returns a flag indicating whether a .odb file which had been previously opened requires upgrading. A non-zero value is returned if upgrading is required. If upgrading is required, use vdm_ABALibUpgradeOdb to upgrade the .odb file.


Table of Contents , ABALib

NAME

vdm_ABALibUpgradeOdb - upgrade .odb file to new version

C SPECIFICATION

void vdm_ABALibUpgradeOdb (vdm_ABALib *abalib,
                           Vchar *odbpath,
                           Vchar *newodbpath)

INPUT ARGUMENTS

abalib       Pointer to ABALib object.
odbpath      Path name of existing .odb file
newodbpath   Path name of new upgraded .odb file

OUTPUT ARGUMENTS

None

ERRORS

SYS_ERROR_OPERATION is generated if the upgrade fails.

DESCRIPTION

Upgrade an existing .odb file to be compatible with the current compiled interface libraries.

Table of Contents

5.12 Adams files - AdamsLib

Read MSC/Adams files.

The methods associated with a AdamsLib object are the following.

Instance a AdamsLib object using vdm_AdamsLibBegin. Once instanced set pointers to abstract data functions using vdm_AdamsLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_AdamsLibSetFunction.

Table of Contents

5.13 Function Descriptions

The currently available AdamsLib functions are described in detail in this section.


Table of Contents , AdamsLib

NAME

*vdm_AdamsLibBegin - create an instance of a AdamsLib object

C SPECIFICATION

vdm_AdamsLib *vdm_AdamsLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created AdamsLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a AdamsLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a AdamsLib object using

     void vdm_AdamsLibEnd (vdm_AdamsLib *adamslib)

Return the current value of a AdamsLib object error flag using

     Vint vdm_AdamsLibError (vdm_AdamsLib *adamslib)


Table of Contents , AdamsLib

NAME

vdm_AdamsLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_AdamsLibDataFun (vdm_AdamsLib *adamslib,
                          vdm_DataFun *datafun);

INPUT ARGUMENTS

adamslib     Pointer to AdamsLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , AdamsLib

NAME

vdm_AdamsLibAbort - set abort flag

C SPECIFICATION

void vdm_AdamsLibAbort (vdm_AdamsLib *adamslib)

INPUT ARGUMENTS

adamslib     Pointer to AdamsLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_AdamsLibSetFunction.


Table of Contents , AdamsLib

NAME

vdm_AdamsLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_AdamsLibSetFunction (vdm_AdamsLib *adamslib,
                              Vint funtype,
                              void (*function)(vdm_AdamsLib*, Vobject*),
                              Vobject *object)

INPUT ARGUMENTS

adamslib     Pointer to AdamsLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.14 AFLR (Mississippi State) Grid File - AFLRFil

The AFLR grid file format is associated with the AFLR grid generation program.

The methods associated with a AFLRFil object are the following.

Instance a AFLRFil object using vdm_AFLRFilBegin. Once instanced set pointers to abstract data functions using vdm_AFLRFilDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_AFLRFilSetFunction.

The boundary triangles and quadrilaterals and generated interior tetrahedra, pyramids, wedges and hexahedra. The interface automatically detects the file format, ie ASCII or binary. The PARTID.E dataset is set to the surface identifier for boundary elements and volume indentifer for interior elements.

Table of Contents

5.15 Function Descriptions

The currently available AFLRFil functions are described in detail in this section.


Table of Contents , AFLRFil

NAME

*vdm_AFLRFilBegin - create an instance of a AFLRFil object

C SPECIFICATION

vdm_AFLRFil *vdm_AFLRFilBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created AFLRFil object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a AFLRFil object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a AFLRFil object using

     void vdm_AFLRFilEnd (vdm_AFLRFil *aflrfil)

Return the current value of a AFLRFil object error flag using

     Vint vdm_AFLRFilError (vdm_AFLRFil *aflrfil)


Table of Contents , AFLRFil

NAME

vdm_AFLRFilDataFun - fill DataFun object

C SPECIFICATION

void vdm_AFLRFilDataFun (vdm_AFLRFil *aflrfil,
                         vdm_DataFun *datafun);

INPUT ARGUMENTS

aflrfil      Pointer to AFLRFil object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , AFLRFil

NAME

vdm_AFLRFilAbort - set abort flag

C SPECIFICATION

void vdm_AFLRFilAbort (vdm_AFLRFil *aflrfil)

INPUT ARGUMENTS

aflrfil      Pointer to AFLRFil object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_AFLRFilSetFunction.


Table of Contents , AFLRFil

NAME

vdm_AFLRFilSetFunction - set a call back functions

C SPECIFICATION

void vdm_AFLRFilSetFunction (vdm_AFLRFil *aflrfil,
                             Vint funtype,
                             void (*function)(vdm_AFLRFil*, Vobject*),
                             Vobject *object)

INPUT ARGUMENTS

aflrfil      Pointer to AFLRFil object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.16 ANSYS Input File - ANSFil

The ANSYS input file is a text file which contains the input description of a finite element model for the ANSYS finite element program.

The methods associated with a ANSFil object are the following.

Instance a ANSFil object using vdm_ANSFilBegin. Once instanced set pointers to abstract data functions using vdm_ANSFilDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_ANSFilSetFunction.

This interface only produces datasets associated with the finite element model, no results datasets are produced. The element types commonly associated with structural and thermal analysis are supported. The total number of ANSYS commands is quite large and ANSFil supports only a small but important subset. This subset is that which is supported by the ANSYS CDWRITE facility. A number of additional commands are also supported which are commonly generated by commercial pre-processing programs. By default, the PARTID.E dataset is set to the property id. Use the VDM_CONVENTION_ALTPART to enable the assignment of part identifiers and part names using body ids and name embedded in /COM comment lines. A property id is generated for each unique set of REAL, MAT, SECNUM and TYPE number combinations.

The interface currently recognizes the following input commands.

Supported Commands
Miscellaneous
Description
/COM
Comment
/TITLE
Define title string
/STITLE
Define subtitle string
Units
Description
EMUNIT
/UNITS
Create Units
Nodes, Elements, Coordinate Systems
Description
ESEL
NSEL
CM
CMBLOCK
Create node and element sets
CSYS
Specify coordinate system
CERIG
EN
EMORE
EBLOCK
Create elements
ESYS
Specify element coordinate system
ET
Define element type
KEYOPT
Specify element options
LOCAL
Create coordinate system
MAT
Specify element material
N
NBLOCK
Create nodes
NROTAT
Specify node coordinate system
REAL
Specify element property
SECNUM
Specify section property
TSHAP
Specify target segment geometry
TYPE
Specify element type
Element Properties
Description
R
RMORE
RLBLOCK
SECBLOCK
SECDATA
SECTYPE
Create an element property
Material Properties
Description
MP
MPDATA
MPTEMP
Create a material property.
Restraints
Description
D
Specify a DOF constraint at nodes
CE
Define a multipoint constraint
CECMOD
Define a multipoint constraint inhomogeneity
CP
Specify a coupled DOF at nodes
M
Specify retained superelement DOF at nodes
Loads
Description
F
Specify a concentrated load at nodes
BFE
Specify an element body force load
SFE
Specify a distributed load
Solution and Control
Description
ANTYPE
CMSOPT
OUTPR
OUTRES
Specify analysis type
SOLVE
Create solution property

Table of Contents

5.17 Function Descriptions

The currently available ANSFil functions are described in detail in this section.


Table of Contents , ANSFil

NAME

*vdm_ANSFilBegin - create an instance of a ANSFil object

C SPECIFICATION

vdm_ANSFil *vdm_ANSFilBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created ANSFil object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a ANSFil object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a ANSFil object using

     void vdm_ANSFilEnd (vdm_ANSFil *ansfil)

Return the current value of a ANSFil object error flag using

     Vint vdm_ANSFilError (vdm_ANSFil *ansfil)


Table of Contents , ANSFil

NAME

vdm_ANSFilDataFun - fill DataFun object

C SPECIFICATION

void vdm_ANSFilDataFun (vdm_ANSFil *ansfil,
                        vdm_DataFun *datafun);

INPUT ARGUMENTS

ansfil       Pointer to ANSFil object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , ANSFil

NAME

vdm_ANSFilAbort - set abort flag

C SPECIFICATION

void vdm_ANSFilAbort (vdm_ANSFil *ansfil)

INPUT ARGUMENTS

ansfil       Pointer to ANSFil object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_ANSFilSetFunction.


Table of Contents , ANSFil

NAME

vdm_ANSFilSetFunction - set a call back functions

C SPECIFICATION

void vdm_ANSFilSetFunction (vdm_ANSFil *ansfil,
                            Vint funtype,
                            void (*function)(vdm_ANSFil*, Vobject*),
                            Vobject *object)

INPUT ARGUMENTS

ansfil       Pointer to ANSFil object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.18 Writing ANSYS Input Files

The ANSFil module also supports the writing of ANSYS input files. Finite element model entities must be contained in a VisTools Model object. The LMan module function vdm_LManSaveModel is used to perform the actual file writing. The file may also be written directly using the Model object function vis_ModelWrite.

The form of the input file is subject to parameters set by the following function.

The interface currently writes the following input commands.

Supported Commands
Miscellaneous
Description
/TITLE
Define title string
/STITLE
Define subtitle string
Nodes, Elements, Coordinate Systems
Description
ESEL
NSEL
CM
CSYS
Define coordinate system
EN
EMORE
ESYS
Define element coordinate system
ET
Define element type
KEYOPT
Define element options
LOCAL
Define coordinate system
MAT
Define element material
N
REAL
Define element property
SECNUM
Define section property
TYPE
Define element type
CERIG
RBE3
Define rigid elements
Element Properties
Description
R
SECCONTROL
SECDATA
SECTYPE
Define an element property
Material Properties
Description
MP
MPDATA
MPTEMP
Define a material property.
Restraints
Description
D
Define a DOF constraint at nodes
CE
Define a multipoint constraint
IC
Define an initial condition
Loads
Description
F
Define a concentrated load at nodes
BF
BFE
Define an element body force load
SFE
Define a distributed load
ACEL
CGOMGA
CGLOC
Define a inertia load
Solution and Control
Description
ANTYPE
BUCOPT
MODOPT
MXPAND
PSTRES
SOLVE
Define solution property
FINISH
End solution

Table of Contents

5.19 Function Descriptions

The additional ANSFil functions are described in detail in this section.


Table of Contents , ANSFil

NAME

vdm_ANSFilSetParami - set control parameters

C SPECIFICATION

void vdm_vdm_ANSFilSetParami (vdm_ANSFil *ansfil,
                              Vint ptype,
                              Vint iparam)

INPUT ARGUMENTS

ansfil       Pointer to ANSFil object.
ptype        Type of display parameter to set
             =ANSFIL_CONTROLCARDS    Toggle writing of control cards
iparam       Specifies the integer value that ptype will be set to.

OUTPUT ARGUMENTS

None

ERRORS

VIS_ERROR_ENUM is generated if an improper ptype is specified.

DESCRIPTION

Specify parameters to control the form of the ANSYS input file which is written.

The parameter ANSFIL_CONTROLCARDS toggles the writing of controls cards. The control cards include the module slash commands such as /PREP7 and /SOLUTION, SOLVE and FINISH. By default ANSFIL_CONTROLCARDS is on.

Table of Contents

5.20 ANSYS .rst, .rth, .rmg, .rfl Results Files - ANSLib

The ANSYS .rst, .rth, .rmg and .rfl files are binary results files produced during an execution of ANSYS for structural, thermal, electro-magnetic and fluid flow analysis. The results files contain model information, loads and boundary conditions, and results data.

The methods associated with a ANSLib object are the following.

Instance a ANSLib object using vdm_ANSLibBegin. Once instanced set pointers to abstract data functions using vdm_ANSLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_ANSLibSetFunction. The PARTID.E dataset is set to the property id, PID.E. Node and element sets are generated for named components for files generated by ANSYS release 18.2 and higher. Node and elements are also generated for the master and duplicate models in cyclic analysis.

Each dataset name in the results data section is appended with the load step number, step and the substep number, incr. The substep number is incremented from one within a load step number.

Each dataset in the results data section has dataset attributes which correspond to the time value associated with the step. One or more of the following dataset attributes are available for each state. Table of Contents

5.21 Function Descriptions

The currently available ANSLib functions are described in detail in this section.


Table of Contents , ANSLib

NAME

*vdm_ANSLibBegin - create an instance of a ANSLib object

C SPECIFICATION

vdm_ANSLib *vdm_ANSLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created ANSLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a ANSLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a ANSLib object using

     void vdm_ANSLibEnd (vdm_ANSLib *anslib)

Return the current value of a ANSLib object error flag using

     Vint vdm_ANSLibError (vdm_ANSLib *anslib)


Table of Contents , ANSLib

NAME

vdm_ANSLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_ANSLibDataFun (vdm_ANSLib *anslib,
                        vdm_DataFun *datafun);

INPUT ARGUMENTS

anslib       Pointer to ANSLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , ANSLib

NAME

vdm_ANSLibAbort - set abort flag

C SPECIFICATION

void vdm_ANSLibAbort (vdm_ANSLib *anslib)

INPUT ARGUMENTS

anslib      Pointer to ANSLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_ANSLibSetFunction.


Table of Contents , ANSLib

NAME

vdm_ANSLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_ANSLibSetFunction (vdm_ANSLib *anslib,
                            Vint funtype,
                            void (*function)(vdm_ANSLib*, Vobject*),
                            Vobject *object)

INPUT ARGUMENTS

anslib       Pointer to ANSLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.


Table of Contents , ANSLib

NAME

vdm_ANSLibSetSearch - set search options

C SPECIFICATION

void vdm_ANSLibSetSearch (vdm_ANSLib *anslib,
                          Vint search)

INPUT ARGUMENTS

anslib       Pointer to ANSLib object.
search       Search type
             =ANSLIB_SEARCH_OFF      Reads single results file
             =ANSLIB_SEARCH_CDB      Reads additional .cdb file

OUTPUT ARGUMENTS

None

ERRORS

SYS_ERROR_ENUM is generated if an improper search is specified.

DESCRIPTION

Set search type. Defaults to ANSLIB_SEARCH_OFF. If ANSLIB_SEARCH_CDB is specified, the ANSYS .cdb file specified by vdm_ANSLibSetSearchPath is scanned for named components, CMBLOCK, and added to the library datasets as node and/or element sets.


Table of Contents , ANSLib

NAME

vdm_ANSLibSetSearchPath - set search path

C SPECIFICATION

void vdm_ANSLibSetSearchPath (vdm_ANSLib *anslib,
                              Vint search,
                              Vchar *pathname)

INPUT ARGUMENTS

anslib       Pointer to ANSLib object.
search       Search type
             =ANSLIB_SEARCH_CDB      Specify path to .cdb file.
pathname     Path name

OUTPUT ARGUMENTS

None

ERRORS

SYS_ERROR_ENUM is generated if an improper search is specified.

DESCRIPTION

Set search path to the file type specified by vdm_ANSLibSetSearch. There is no default.

Table of Contents

5.22 ANSYS AUTODYN results files - AUTODYNLib

The ANSYS AUTODYN results database is a collection of files resident in a single directory resulting from an execution of ANSYS AUTODYN. Support for the AUTODYN results file requires 3rd party software from ANSYS.

The methods associated with a AUTODYNLib object are the following.

Instance a AUTODYNLib object using vdm_AUTODYNLibBegin. Once instanced set pointers to abstract data functions using vdm_AUTODYNLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_AUTODYNLibSetFunction.

The key file must be any .adres file located in the directory. The results files contain model and results data. The PARTID.E dataset is set to the part number. Each dataset name in the results data section is appended with a time step number.

Each dataset in the results data section has dataset attributes which correspond to the time value associated with the step. One or more of the following dataset attributes are available for each state.

Table of Contents

5.23 Function Descriptions

The currently available AUTODYNLib functions are described in detail in this section.


Table of Contents , AUTODYNLib

NAME

*vdm_AUTODYNLibBegin - create an instance of a AUTODYNLib object

C SPECIFICATION

vdm_AUTODYNLib *vdm_AUTODYNLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created AUTODYNLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a AUTODYNLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a AUTODYNLib object using

     void vdm_AUTODYNLibEnd (vdm_AUTODYNLib *autodynlib)

Return the current value of a AUTODYNLib object error flag using

     Vint vdm_AUTODYNLibError (vdm_AUTODYNLib *autodynlib)


Table of Contents , AUTODYNLib

NAME

vdm_AUTODYNLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_AUTODYNLibDataFun (vdm_AUTODYNLib *autodynlib,
                            vdm_DataFun *datafun);

INPUT ARGUMENTS

autodynlib   Pointer to AUTODYNLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , AUTODYNLib

NAME

vdm_AUTODYNLibAbort - set abort flag

C SPECIFICATION

void vdm_AUTODYNLibAbort (vdm_AUTODYNLib *autodynlib)

INPUT ARGUMENTS

autodynlib      Pointer to AUTODYNLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_AUTODYNLibSetFunction.


Table of Contents , AUTODYNLib

NAME

vdm_AUTODYNLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_AUTODYNLibSetFunction (vdm_AUTODYNLib *autodynlib,
                                Vint funtype,
                                void (*function)(vdm_AUTODYNLib*, Vobject*),
                                Vobject *object)

INPUT ARGUMENTS

autodynlib   Pointer to AUTODYNLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.24 CFX results file - CFXLib

The CFX format file is generated by the ANSYS CFX solver. The file suffix is .res.

The methods associated with a CFXLib object are the following.

Instance a CFXLib object using vdm_CFXLibBegin. Once instanced set pointers to abstract data functions using vdm_CFXLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_CFXLibSetFunction.

Support for the CFX results file requires 3rd party software from ANSYS. The PARTID.E dataset is set to the zone number. The results file only contains results at nodes.

Each results dataset name is appended with the time step number, id.

Table of Contents

5.25 Function Descriptions

The currently available CFXLib functions are described in detail in this section.


Table of Contents , CFXLib

NAME

*vdm_CFXLibBegin - create an instance of a CFXLib object

C SPECIFICATION

vdm_CFXLib *vdm_CFXLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created CFXLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a CFXLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a CFXLib object using

     void vdm_CFXLibEnd (vdm_CFXLib *cfxlib)

Return the current value of a CFXLib object error flag using

     Vint vdm_CFXLibError (vdm_CFXLib *cfxlib)


Table of Contents , CFXLib

NAME

vdm_CFXLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_CFXLibDataFun (vdm_CFXLib *cfxlib,
                        vdm_DataFun *datafun);

INPUT ARGUMENTS

cfxlib       Pointer to CFXLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , CFXLib

NAME

vdm_CFXLibAbort - set abort flag

C SPECIFICATION

void vdm_CFXLibAbort (vdm_CFXLib *cfxlib)

INPUT ARGUMENTS

cfxlib      Pointer to CFXLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_CFXLibSetFunction.


Table of Contents , CFXLib

NAME

vdm_CFXLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_CFXLibSetFunction (vdm_CFXLib *cfxlib,
                            Vint funtype,
                            void (*function)(vdm_CFXLib*, Vobject*),
                            Vobject *object)

INPUT ARGUMENTS

cfxlib       Pointer to CFXLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.26 CGNS data base - CGNSVLib

The CGNS data base is a collection of conventions and software for the storage and retrieval of CFD data. Support for the CGNS data base requires 3rd party software from the CGNS organization available at the following URL.
http://cgns.sourceforge.net

The methods associated with a CGNSVLib object are the following.

Instance a CGNSVLib object using vdm_CGNSVLibBegin. Once instanced set pointers to abstract data functions using vdm_CGNSVLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_CGNSVLibSetFunction.

The CGNS data base is supported for both reading and writing. The data base file name usually contains a ".cgns" suffix.

The CGNS reader supports both structured and unstructured zones. All topology types are supported. The PARTID.E dataset is set to the zone/section id. Elements in each structured zone are assigned a single part identifier. Elements in each section of an unstructured zone are assigned a single part identifier. The zone/section ids are assigned sequentially starting from 1 as they are encountered.

Each results dataset name is appended with the flow solution index number, id.

This interface supports the import of unknown variables. Any specific CGNS variable name (data name identifier for flow solution quantity) which does not match the current list of VdmTools specific variable names will be imported as SYS_RES_UNKNOWN. The dataset name will include the CGNS variable name immediately after the dataset root name (UNKNOWN). See section VdmTools, Finite Element Result Dataset Names and Descriptions for a description of VdmTools specific variable names. The variable names are the "Contents" string.

Supported Variable Names, Results

CGNS Variable Name
Dataset
Temperature
TEMP
TemperatureStagnation
TEMP.[STAG]
Entropy
ENTROPY
Enthalpy
H
EnthalpyStagnation
H.[STAG]
EnergyStagnation
ENERGY.[STAG]
EnergyInternal
ENERGY.[INTERNAL]
EnergyStagnationDensity
ENERGY_DENSITY.[STAG]
SkinFriction
WALL_SHEAR
TurbulentDistance
TURB_DIST
TurbulentEnergyKinetic
TURB_KE
ReynoldsStress
S.[REYNOLDS]
TurbulentDissipationRate
TURB_ED
ViscosityEddy
VISC_EDDY
Prandtl
PRANDTL
Pressure
PRES
CoefPressure
PRES_COEF
PressureStagnation
PRES.[STAG]
PressureDynamic
PRES.[DYNAMIC]
Density
DENS
Velocity
V
Momentum
P
Vorticity
VORTICITY
EnergyKinetic
KE
SpecificHeatVolume
CP
Mach
MACH
StreamFunction
STREAM

The convention, VDM_CONVENTION_DOUBLE, can be used to export floating point data in single or double precision. The default export precision is single. All nodes and elements are exported as a single unstructured zone. All CGNS topology types are supported except polygons. A section is exported for all solid elements of dimension equal to the CGNS physical dimension with a similar VIS_PARTID element association. A section is exported for all interface elements of dimension equal to one less than the CGNS physical dimension with a similar VIS_PARTID element association and a similar partid of an attached solid element. A section is also exported for all other elements with a similar VIS_PARTID element association.

There is an option using a non standard method to specify the file type used when exporting to a CGNS file. The file types are HDF5 and ADF.

Scalar, vector and symmetric tensor data types are exported, all others are ignored. All element node results are converted to an element result for output. All node and element results are converted to the global coordinate system. If a VdmTools specific type is written, the CGNS variable names in the table above are first searched, otherwise the specific variable type contents are used and abbreviated as needed.

Table of Contents

5.27 Function Descriptions

The CGNSVLib functions are described in detail in this section.


Table of Contents , CGNSVLib

NAME

*vdm_CGNSVLibBegin - create an instance of a CGNSVLib object

C SPECIFICATION

vdm_CGNSVLib *vdm_CGNSVLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created CGNSVLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a CGNSVLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a CGNSVLib object using

     void vdm_CGNSVLibEnd (vdm_CGNSVLib *cgnsvlib)

Return the current value of a CGNSVLib object error flag using

     Vint vdm_CGNSVLibError (vdm_CGNSVLib *cgnsvlib)


Table of Contents , CGNSVLib

NAME

vdm_CGNSVLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_CGNSVLibDataFun (vdm_CGNSVLib *cgnsvlib,
                          vdm_DataFun *datafun);

INPUT ARGUMENTS

cgnsvlib     Pointer to CGNSVLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , CGNSVLib

NAME

vdm_CGNSVLibAbort - set abort flag

C SPECIFICATION

void vdm_CGNSVLibAbort (vdm_CGNSVLib *cgnsvlib)

INPUT ARGUMENTS

cgnsvlib      Pointer to CGNSVLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_CGNSVLibSetFunction.


Table of Contents , CGNSVLib

NAME

vdm_CGNSVLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_CGNSVLibSetFunction (vdm_CGNSVLib *cgnsvlib,
                              Vint funtype,
                              void (*function)(vdm_CGNSVLib*, Vobject*),
                              Vobject *object)

INPUT ARGUMENTS

cgnsvlib     Pointer to CGNSVLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.


Table of Contents , CGNSVLib

NAME

vdm_CGNSVLibSetWriteFileType - specify export file type

C SPECIFICATION

void vdm_CGNSVLibSetWriteFileType (vdm_CGNSVLib *cgnsvlib,
                                   Vint filetype)

INPUT ARGUMENTS

cgnsvlib     Pointer to CGNSVLib object.
filetype     Type of file type for export
             =CGNSVLIB_HDF5          HDF5 file format
             =CGNSVLIB_ADF           ADF file format

OUTPUT ARGUMENTS

None

ERRORS

SYS_ERROR_ENUM is generated if an improper type is specified.

DESCRIPTION

Set file type used for export. The default type is CGNSVLIB_ADF.


Table of Contents , CGNSVLib

NAME

vdm_CGNSVLibSetSearch - set user specified search types

C SPECIFICATION

void vdm_CGNSVLibSetSearch (vdm_CGNSVLib *cgnsvlib,
                            Vint search)

INPUT ARGUMENTS

cgnsvlib     Pointer to CGNSVLib object.
search       Search type
             =CGNSVLIB_SEARCH_OFF    Reads a single file
             =CGNSVLIB_SEARCH_DIRNUM Searches based on directory number
             =CGNSVLIB_SEARCH_DIRNUMFILENUM Searches based on directory and file number
             =CGNSVLIB_SEARCH_FILENUM Searches based on file number

OUTPUT ARGUMENTS

None

ERRORS

SYS_ERROR_ENUM is generated if an improper search is specified.

DESCRIPTION

Set search type. Defaults to CGNSVLIB_SEARCH_OFF.

Table of Contents

5.28 COMSOL MPH and Sectionwise file - COMSOLLib

The COMSOL Multiphysics file is an ASCII or binary file. The file name usually contains the letters "mph". The ASCII file usually has the extension .txt and the binary file has the extension .bin. The COMSOL Sectionwise file is an ASCII file - usually with extension .txt - produced by COMSOL. More information about COMSOL is available at the URL
http://www.comsol.com

The methods associated with a COMSOLLib object are the following.

Instance a COMSOLLib object using vdm_COMSOLLibBegin. Once instanced set pointers to abstract data functions using vdm_COMSOLLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_COMSOLLibSetFunction.

The COMSOL MPH file contains either mesh entities or results.

The COMSOL Sectionwise file contains a triangular discretization in two dimensions or a tetrahedron discretization in three dimensions. The geometry is followed by a series of nodal scalar results.

Each results dataset name is appended with the flow solution index number, id.

This interface supports the import of unknown variables. Any specific variable name which does not match the current list of VdmTools specific variable names will be imported as SYS_RES_UNKNOWN. The dataset name will include the COMSOL variable name immediately after the dataset root name (UNKNOWN). See section VdmTools, Finite Element Result Dataset Names and Descriptions for a description of VdmTools specific variable names. The variable names are the "Contents" string.

Supported Variable Names, Results

COMSOL Variable Name
Dataset
p
PRES
spf.U
V.[MAG]

Table of Contents

5.29 Function Descriptions

The currently available COMSOLLib functions are described in detail in this section.


Table of Contents , COMSOLLib

NAME

*vdm_COMSOLLibBegin - create an instance of a COMSOLLib object

C SPECIFICATION

vdm_COMSOLLib *vdm_COMSOLLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created COMSOLLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a COMSOLLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a COMSOLLib object using

     void vdm_COMSOLLibEnd (vdm_COMSOLLib *comsollib)

Return the current value of a COMSOLLib object error flag using

     Vint vdm_COMSOLLibError (vdm_COMSOLLib *comsollib)


Table of Contents , COMSOLLib

NAME

vdm_COMSOLLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_COMSOLLibDataFun (vdm_COMSOLLib *comsollib,
                           vdm_DataFun *datafun);

INPUT ARGUMENTS

comsollib    Pointer to COMSOLLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , COMSOLLib

NAME

vdm_COMSOLLibAbort - set abort flag

C SPECIFICATION

void vdm_COMSOLLibAbort (vdm_COMSOLLib *comsollib)

INPUT ARGUMENTS

comsollib      Pointer to COMSOLLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_COMSOLLibSetFunction.


Table of Contents , COMSOLLib

NAME

vdm_COMSOLLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_COMSOLLibSetFunction (vdm_COMSOLLib *comsollib,
                               Vint funtype,
                               void (*function)(vdm_COMSOLLib*, Vobject*),
                               Vobject *object)

INPUT ARGUMENTS

comsollib    Pointer to COMSOLLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.30 LSTC LS-DYNA input file - D3DFil

The LSTC LS-DYNA input file is a text file which contains the input description of a finite element model for the LS-DYNA finite element program.

The methods associated with a D3DFil object are the following.

Instance a D3DFil object using vdm_D3DFilBegin. Once instanced set pointers to abstract data functions using vdm_D3DFilDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_D3DFilSetFunction.

This interface only produces datasets associated with the finite element model, no results datasets are produced. The element types commonly associated with structural analysis are supported. The PARTID.E dataset is set to the part id. The interface currently recognizes the following input keywords.

Supported Keywords
Miscellaneous
Description
*TITLE
Create title string
*INCLUDE
*INCLUDE_TRANSFORM
*DEFINE_TRANSFORMATION
Read from specified file
Nodes, Elements, Coordinate Systems
Description
*NODE
Create node, add constraints to restraint case
*SET_NODE_LIST
*SET_NODE_LIST_GENERATE
*SET_NODE_GENERAL
Create node set, the BOX and DBOX options are not supported
*ELEMENT_SOLID_{OPTION}
*ELEMENT_TSHELL
Create 3D solid element.
*ELEMENT_SHELL_{OPTION}
Create 3D shell element.
*ELEMENT_BEAM_{OPTION}
Create 3D beam element.
*ELEMENT_MASS
*ELEMENT_INERTIA,
Create mass element and mass element property
*ELEMENT_DISCRETE
*ELEMENT_SEATBELT
Create spring dashpot element
*SET_BEAM
*SET_BEAM_GENERATE
*SET_BEAM_GENERAL
*SET_DISCRETE
*SET_DISCRETE_GENERATE
*SET_DISCRETE_GENERAL
*SET_SHELL_LIST
*SET_SHELL_LIST_GENERATE
*SET_SHELL_GENERAL
*SET_SOLID
*SET_SOLID_GENERATE
*SET_SOLID_GENERAL
*SET_TSHELL
*SET_TSHELL_GENERATE
*SET_TSHELL_GENERAL
*SET_PART_LIST
*SET_PART_LIST_GENERATE
Create element set
*DEFINE_COORDINATE_NODES
*DEFINE_COORDINATE_SYSTEM
*DEFINE_COORDINATE_VECTOR
Create coordinate system
Element Properties
Description
*PART
Create element property
*SECTION_SOLID
Define solid element properties
*SECTION_SHELL
Define shell element properties
*SECTION_BEAM
Define beam element properties
Material Properties
Description
*MAT_ELASTIC
Create linear elastic material property
Loads, Initial Conditions
Description
*LOAD_NODE
Define concentrated load
*DEFINE_CURVE
Create load curve
Restraints
Description
*BOUNDARY_SPC
*BOUNDARY_SPC_NODE
*BOUNDARY_SPC_SET
Define degree of freedom restraints
*CONSTRAINED_LINEAR
Define multipoint constraint

Table of Contents

5.31 Function Descriptions

The currently available D3DFil functions are described in detail in this section.


Table of Contents , D3DFil

NAME

*vdm_D3DFilBegin - create an instance of a D3DFil object

C SPECIFICATION

vdm_D3DFil *vdm_D3DFilBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created D3DFil object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a D3DFil object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a D3DFil object using

     void vdm_D3DFilEnd (vdm_D3DFil *d3dfil)

Return the current value of a D3DFil object error flag using

     Vint vdm_D3DFilError (vdm_D3DFil *d3dfil)


Table of Contents , D3DFil

NAME

vdm_D3DFilDataFun - fill DataFun object

C SPECIFICATION

void vdm_D3DFilDataFun (vdm_D3DFil *d3dfil,
                        vdm_DataFun *datafun);

INPUT ARGUMENTS

d3dfil       Pointer to D3DFil object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , D3DFil

NAME

vdm_D3DFilAbort - set abort flag

C SPECIFICATION

void vdm_D3DFilAbort (vdm_D3DFil *d3dfil)

INPUT ARGUMENTS

d3dfil      Pointer to D3DFil object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_D3DFilSetFunction.


Table of Contents , D3DFil

NAME

vdm_D3DFilSetFunction - set a call back functions

C SPECIFICATION

void vdm_D3DFilSetFunction (vdm_D3DFil *d3dfil,
                            Vint funtype,
                            void (*function)(vdm_D3DFil*, Vobject*),
                            Vobject *object)

INPUT ARGUMENTS

d3dfil       Pointer to D3DFil object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.32 LSTC LS-DYNA State and Time History Databases - D3DLib

The state and/or time history databases are produced as a result of an execution of the LS-DYNA program offered by Livermore Software Technology Corporation (LSTC). The interface supports both single and double precision files.

The methods associated with a D3DLib object are the following.

Instance a D3DLib object using vdm_D3DLibBegin. Once instanced set pointers to abstract data functions using vdm_D3DLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_D3DLibSetFunction.

The state database consists of a series (family) of files generally named d3plot, d3plot01, d3plot02, etc. The key file to be opened is the first file in the family, d3plot. There are three major sections in the database; control data, geometry data, and state data. The data management system maps dataset names and attributes to all data in each section of the database. The PARTID.E dataset is set to the material id. Each dataset name in the state data section is appended with the state number, state.

The spot weld force file, swforc, is read, by default, if it exists in the same directory as the key state d3plot file. The node contact force file, ncforc, is read, by default, if it exists in the same directory as the key state d3plot file. Note that the time steps of the node contact forces may not correspond exactly to the state times. In this case the dataset id1 identifier is the same as the state number (base state) of the state time which is the largest time that is less than or equal to the node contact force time. An additional id2 identifer is appended which counts serially the number of node contact force datasets which are larger than the base state. Use vdm_D3DLibSetSearch to change the search options for these files.

The time history database also consists of three major sections; control data, geometry data and time history data. The PARTID.E dataset is set to the material id.

Supported Variable Names, Results

Dataset
LS-DYNA State Value
X
V
A
TEMP
NODEDATA
S
E.[EQUIV,PLAST]
SFM
THICKNESS
SE
E
DELETED
ELEMDATA
DENS.[FLUID]
DOM_FLUID_PHASE
MASS
VOF
ELEMDATA ALE
ID.[GAS].PCL
MASS.PCL
X.PCL
V.PCL
PARTICLE DATA
SF.[AXIAL,WELD]
SF.[SHEAR,WELD]
LENGTH.[WELD]
swforc
FORCE.[CONTACT]
PRES.[CONTACT]
ncforc

Each dataset in the state data section has dataset attributes which correspond to the time word and global data items associated with each state on the database. One or more of the following dataset attributes are available for each state.

Table of Contents

5.33 Function Descriptions

The currently available D3DLib functions are described in detail in this section.


Table of Contents , D3DLib

NAME

*vdm_D3DLibBegin - create an instance of a D3DLib object

C SPECIFICATION

vdm_D3DLib *vdm_D3DLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created D3DLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a D3DLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a D3DLib object using

     void vdm_D3DLibEnd (vdm_D3DLib *d3dlib)

Return the current value of a D3DLib object error flag using

     Vint vdm_D3DLibError (vdm_D3DLib *d3dlib)


Table of Contents , D3DLib

NAME

vdm_D3DLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_D3DLibDataFun (vdm_D3DLib *d3dlib,
                        vdm_DataFun *datafun);

INPUT ARGUMENTS

d3dlib       Pointer to D3DLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , D3DLib

NAME

vdm_D3DLibAbort - set abort flag

C SPECIFICATION

void vdm_D3DLibAbort (vdm_D3DLib *d3dlib)

INPUT ARGUMENTS

d3dlib      Pointer to D3DLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_D3DLibSetFunction.


Table of Contents , D3DLib

NAME

vdm_D3DLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_D3DLibSetFunction (vdm_D3DLib *d3dlib,
                            Vint funtype,
                            void (*function)(vdm_D3DLib*, Vobject*),
                            Vobject *object)

INPUT ARGUMENTS

d3dlib       Pointer to D3DLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.


Table of Contents , D3DLib

NAME

vdm_D3DLibSetSearch - set user specified search types

C SPECIFICATION

void vdm_D3DLibSetSearch (vdm_D3DLib *d3dlib,
                          Vint search)

INPUT ARGUMENTS

d3dlib       Pointer to D3DLib object.
search       Search type
             =D3DLIB_SEARCH_SWFORC     Search for swforc file
             =D3DLIB_SEARCH_SWFORC_OFF Do not search for swforc file
             =D3DLIB_SEARCH_NCFORC     Search for ncforc file
             =D3DLIB_SEARCH_NCFORC_OFF Do not search for ncforc file

OUTPUT ARGUMENTS

None

DESCRIPTION

Set search type. By default all searching is enabled.

Table of Contents

5.34 EnSight Casefile format - EnSightLib

The EnSight Casefile format consists of a Case file and associated files.

The methods associated with a EnSightLib object are the following.

Instance a EnSightLib object using vdm_EnSightLibBegin. Once instanced set pointers to abstract data functions using vdm_EnSightLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_EnSightLibSetFunction.

The EnSight Casefile format is supported for both reading and writing. The Case file points to all other needed files including model geometry and variables. The Case file usually contains a ".case" suffix. The reader supports both structured and unstructured parts. All topology types are supported including polygon and polyhedron. The PARTID.E dataset is set to the part id.

Each results dataset name is appended with the time solution number which is encoded in the file name number.

This interface supports the import of unknown variables. Any specific variable description which does not match the current list of VdmTools specific variable names will be imported as SYS_RES_UNKNOWN. The dataset name will include the Ensight variable description immediately after the dataset root name (UNKNOWN). See section VdmTools, Finite Element Result Dataset Names and Descriptions for a description of VdmTools specific variable names. The variable names are the "Contents" string.

Supported Variable Names, Results

Ensight Variable Description Dataset
Displacement D
Pressure PRES
Strain E
Stress S
Temperature TEMP
Velocity V

The Ensight writer only supports binary Ensight Gold format. All floating point data is exported in single precision. All nodes and elements are exported as unstructured parts. A part is exported for all elements with a similar VIS_PARTID element association. All linear and Serendipity parabolic elements, polygons and polyhedra are written. Lagrange elements are ignored.

Scalar, vector and symmetric tensor data types are exported, all others are ignored. All element node results are converted to an element result for output. All node and element results are converted to the global coordinate system. If a VdmTools specific type is written, the Ensight variable description is set to a four character abbreviation of the "Contents" string. If an unknown type, SYS_RES_UNKNOWN, is written, the variable description is set to the first four characters of the RProp object cqua string. All blanks are replaced with underscores, "_". The last non-zero dataset identifier is time varying, all other identifiers are embedded directly in the variable description.

Table of Contents

5.35 Function Descriptions

The currently available EnSightLib functions are described in detail in this section.


Table of Contents , EnSightLib

NAME

*vdm_EnSightLibBegin - create an instance of a EnSightLib object

C SPECIFICATION

vdm_EnSightLib *vdm_EnSightLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created EnSightLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a EnSightLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a EnSightLib object using

     void vdm_EnSightLibEnd (vdm_EnSightLib *ensightlib)

Return the current value of a EnSightLib object error flag using

     Vint vdm_EnSightLibError (vdm_EnSightLib *ensightlib)


Table of Contents , EnSightLib

NAME

vdm_EnSightLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_EnSightLibDataFun (vdm_EnSightLib *ensightlib,
                            vdm_DataFun *datafun);

INPUT ARGUMENTS

ensightlib   Pointer to EnSightLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , EnSightLib

NAME

vdm_EnSightLibAbort - set abort flag

C SPECIFICATION

void vdm_EnSightLibAbort (vdm_EnSightLib *ensightlib)

INPUT ARGUMENTS

ensightlib      Pointer to EnSightLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_EnSightLibSetFunction.


Table of Contents , EnSightLib

NAME

vdm_EnSightLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_EnSightLibSetFunction (vdm_EnSightLib *ensightlib,
                                Vint funtype,
                                void (*function)(vdm_EnSightLib*, Vobject*),
                                Vobject *object)

INPUT ARGUMENTS

ensightlib   Pointer to EnSightLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.36 FEMAP Neutral File - FEMAPLib

The FEMAP Neutral File is an ASCII file which contains mesh data and results data.

The methods associated with a FEMAPLib object are the following.

Instance a FEMAPLib object using vdm_FEMAPLibBegin. Once instanced set pointers to abstract data functions using vdm_FEMAPLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_FEMAPLibSetFunction.

The FEMAP reader reads all node coordinates, element types and connectivity and coordinate systems. Constraint sets are also read. All node and element groups become node and element sets. The PARTID.E dataset is set to the property id.

Each dataset name in the results section of the file is appended with the output set number.

Table of Contents

5.37 Function Descriptions

The currently available FEMAPLib functions are described in detail in this section.


Table of Contents , FEMAPLib

NAME

*vdm_FEMAPLibBegin - create an instance of a FEMAPLib object

C SPECIFICATION

vdm_FEMAPLib *vdm_FEMAPLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created FEMAPLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a FEMAPLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a FEMAPLib object using

     void vdm_FEMAPLibEnd (vdm_FEMAPLib *femaplib)

Return the current value of a FEMAPLib object error flag using

     Vint vdm_FEMAPLibError (vdm_FEMAPLib *femaplib)


Table of Contents , FEMAPLib

NAME

vdm_FEMAPLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_FEMAPLibDataFun (vdm_FEMAPLib *femaplib,
                          vdm_DataFun *datafun);

INPUT ARGUMENTS

femaplib     Pointer to FEMAPLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , FEMAPLib

NAME

vdm_FEMAPLibAbort - set abort flag

C SPECIFICATION

void vdm_FEMAPLibAbort (vdm_FEMAPLib *femaplib)

INPUT ARGUMENTS

femaplib      Pointer to FEMAPLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_FEMAPLibSetFunction.


Table of Contents , FEMAPLib

NAME

vdm_FEMAPLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_FEMAPLibSetFunction (vdm_FEMAPLib *femaplib,
                              Vint funtype,
                              void (*function)(vdm_FEMAPLib*, Vobject*),
                              Vobject *object)

INPUT ARGUMENTS

femaplib     Pointer to FEMAPLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.38 FIDAP Neutral File - FDILib

The FIDAP Neutral File format is generated by ANSYS FIDAP program.

The methods associated with a FDILib object are the following.

Instance a FDILib object using vdm_FDILibBegin. Once instanced set pointers to abstract data functions using vdm_FDILibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_FDILibSetFunction.

Table of Contents

5.39 Function Descriptions

The currently available FDILib functions are described in detail in this section.


Table of Contents , FDILib

NAME

*vdm_FDILibBegin - create an instance of a FDILib object

C SPECIFICATION

vdm_FDILib *vdm_FDILibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created FDILib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a FDILib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a FDILib object using

     void vdm_FDILibEnd (vdm_FDILib *fdilib)

Return the current value of a FDILib object error flag using

     Vint vdm_FDILibError (vdm_FDILib *fdilib)


Table of Contents , FDILib

NAME

vdm_FDILibDataFun - fill DataFun object

C SPECIFICATION

void vdm_FDILibDataFun (vdm_FDILib *fdilib,
                        vdm_DataFun *datafun);

INPUT ARGUMENTS

fdilib    Pointer to FDILib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , FDILib

NAME

vdm_FDILibAbort - set abort flag

C SPECIFICATION

void vdm_FDILibAbort (vdm_FDILib *fdilib)

INPUT ARGUMENTS

fdilib      Pointer to FDILib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_FDILibSetFunction.


Table of Contents , FDILib

NAME

vdm_FDILibSetFunction - set a call back functions

C SPECIFICATION

void vdm_FDILibSetFunction (vdm_FDILib *fdilib,
                            Vint funtype,
                            void (*function)(vdm_FDILib*, Vobject*),
                            Vobject *object)

INPUT ARGUMENTS

fdilib       Pointer to FDILib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.40 FLUENT Case and Data File - FLUENTLib

The FLUENT Case File format is an ASCII file format with optional embedded binary sections. There are two types of files: 1) a case file which contains the node, cell and face model information and 2) a data file which contains solution results information. The case file name usually contains a ".cas" or ".msh" suffix, the data file name usually contains a ".dat" suffix.

The methods associated with a FLUENTLib object are the following.

Instance a FLUENTLib object using vdm_FLUENTLibBegin. Once instanced set pointers to abstract data functions using vdm_FLUENTLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_FLUENTLibSetFunction.

The interface supports all cell and face types. All active cells are represented as solid elements. All inactive cells do not appear as elements, however their existence is used in the support of "hanging nodes". The zone_id of all cells and faces represented by elements is used to generate element part identifiers. An element face or edge set is generated for each external face zone. The PARTID.E dataset is set to the zone id.

Results are read for solution record type 300 and user defined record type 314. Each results dataset name is appended with the value of the "time-step" variable in section 37 Variables. If the "time-step" variable is not present then 1 is appended.

Supported Solution Variables, Results

Fluent Subsection Id
Dataset
1
PRES
2
P
3
TEMP
4
H
5
TURB_KE
6
TURB_ED
15
BODY_FORCE
18
MASS_FLUX
19
WALL_SHEAR
20
HEAT_FLUX
21
HEAT_FLUX.[RADIATION]
35
YPLUS
36
UTAU
38
TEMP.[Wall,Inner]
47
MASS_FLUX.[M1]
48
MASS_FLUX.[M2]
59
MACH
67
TEMP.[Granular]
70
VOLUME_FLUX
80
VOLUME_FLUX.[M1]
90
VOLUME_FLUX.[M2]
96
TURB_DIST
101
DENS
102
MU_LAMB
103
MU_TURB
104
CP
111
112
113
V
114
V.[Wall]
115
116
117
V.[M1]
119
TURB_KE.[M1]
120
TURB_ED.[M1]
126
TURB_KE.[M2]
127
TURB_ED.[M2]
128
129
130
131
132
133
S.[REYNOLDS]
150
VOF
160
VOF.[M1]
196
TEMP.[Variance]
500
VISC_EDDY
515
ENERGY.[M1]
516
ENERGY.[M2]
517
DENS.[M1]
518
DENS.[M2]
8553
V.[Wall,Original]

Table of Contents

5.41 Function Descriptions

The currently available FLUENTLib functions are described in detail in this section.


Table of Contents , FLUENTLib

NAME

*vdm_FLUENTLibBegin - create an instance of a FLUENTLib object

C SPECIFICATION

vdm_FLUENTLib *vdm_FLUENTLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created FLUENTLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a FLUENTLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a FLUENTLib object using

     void vdm_FLUENTLibEnd (vdm_FLUENTLib *fluentlib)

Return the current value of a FLUENTLib object error flag using

     Vint vdm_FLUENTLibError (vdm_FLUENTLib *fluentlib)


Table of Contents , FLUENTLib

NAME

vdm_FLUENTLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_FLUENTLibDataFun (vdm_FLUENTLib *fluentlib,
                           vdm_DataFun *datafun);

INPUT ARGUMENTS

fluentlib    Pointer to FLUENTLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , FLUENTLib

NAME

vdm_FLUENTLibAbort - set abort flag

C SPECIFICATION

void vdm_FLUENTLibAbort (vdm_FLUENTLib *fluentlib)

INPUT ARGUMENTS

fluentlib      Pointer to FLUENTLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_FLUENTLibSetFunction.


Table of Contents , FLUENTLib

NAME

vdm_FLUENTLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_FLUENTLibSetFunction (vdm_FLUENTLib *fluentlib,
                               Vint funtype,
                               void (*function)(vdm_FLUENTLib*, Vobject*),
                               Vobject *object)

INPUT ARGUMENTS

fluentlib    Pointer to FLUENTLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.42 General Mesh Viewer File Format - GMVLib

The General Mesh Viewer file is a text file which contains model and results data. The file format was originally developed by Los Alamos National Laboratory.

The methods associated with a GMVLib object are the following.

Instance a GMVLib object using vdm_GMVLibBegin. Once instanced set pointers to abstract data functions using vdm_GMVLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_GMVLibSetFunction.

The PARTID.E dataset is set to the material number.

Each results dataset name is appended with the time step number, id.

A REMESH.L dataset is created for each file which satisfies the search criterion. Table of Contents

5.43 Function Descriptions

The GMVlib functions are described in detail in this section.


Table of Contents , GMVLib

NAME

*vdm_GMVLibBegin - create an instance of a GMVLib object

C SPECIFICATION

vdm_GMVLib *vdm_GMVLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created GMVLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a GMVLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a GMVLib object using

     void vdm_GMVLibEnd (vdm_GMVLib *gmvlib)

Return the current value of a GMVLib object error flag using

     Vint vdm_GMVLibError (vdm_GMVLib *gmvlib)


Table of Contents , GMVLib

NAME

vdm_GMVLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_GMVLibDataFun (vdm_GMVLib *gmvlib,
                        vdm_DataFun *datafun);

INPUT ARGUMENTS

gmvlib       Pointer to GMVLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , GMVLib

NAME

vdm_GMVLibAbort - set abort flag

C SPECIFICATION

void vdm_GMVLibAbort (vdm_GMVLib *gmvlib)

INPUT ARGUMENTS

gmvlib      Pointer to GMVLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_GMVLibSetFunction.


Table of Contents , GMVLib

NAME

vdm_GMVLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_GMVLibSetFunction (vdm_GMVLib *gmvlib,
                            Vint funtype,
                            void (*function)(vdm_GMVLib*, Vobject*),
                            Vobject *object)

INPUT ARGUMENTS

gmvlib       Pointer to GMVLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.


Table of Contents , GMVLib

NAME

vdm_GMVLibSetSearch - set user specified search types

C SPECIFICATION

void vdm_GMVLibSetSearch (vdm_GMVLib *gmvlib,
                          Vint search)

INPUT ARGUMENTS

gmvlib       Pointer to GMVLib object.
search       Search type
             =GMVLIB_SEARCH_OFF        Single file
             =GMVLIB_SEARCH_FILENUM    File names follow numbering sequence

OUTPUT ARGUMENTS

None

DESCRIPTION

Set search type. if search is GMVLIB_SEARCH_OFF then a single file is read.

If GMVLIB_SEARCH_FILENUM is specified (default), then the file being opened is the first in a directory. It is assumed that file names terminate with an integer that specify a time step id, and all time step ids larger or equal to the initially specified file are added.

Table of Contents

5.44 Altair Engineering HyperMesh ASCII File - HMAFil

The HyperMesh ASCII file is a text file which contains the input description of a finite element or finite difference model. This interface supports mesh entities only, no results datasets are produced. The PARTID.E dataset is set to the component id. The interface currently recognizes the following input commands.

Supported Commands
Miscellaneous
Description
*title
Create title string
Nodes, Elements, Coordinate Systems
Description
*node
Create node
*component
Create element part
*hexa8
*hexa20
*penta6
*penta15
*tetra4
*tetra10
Create 3D solid element.
*quad4
*quad8
*tria3
*tria6
Create 3D shell element.
*bar2
*bar3
*rod
Create 3D beam element.
*mass
Create mass element
*spring
*spring1
*weld
Create spring dashpot element
*gap
Create gap element
*rbe3
*rigid
*rigidlink
*dependentnodes
*independentnodes
Create rigid element
*plotel
Create plot element
*system
Create coordinate system

The methods associated with a HMAFil object are the following.

Instance a HMAFil object using vdm_HMAFilBegin. Once instanced set pointers to abstract data functions using vdm_HMAFilDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_HMAFilSetFunction.

The PARTID.E dataset is set to the component identifier.

Each results dataset is appended with two identifiers, the first is the subcase id and the second is the simulation id.

Table of Contents

5.45 Function Descriptions

The currently available HMAFil functions are described in detail in this section.


Table of Contents , HMAFil

NAME

*vdm_HMAFilBegin - create an instance of a HMAFil object

C SPECIFICATION

vdm_HMAFil *vdm_HMAFilBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created HMAFil object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a HMAFil object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a HMAFil object using

     void vdm_HMAFilEnd (vdm_HMAFil *HMAFil)

Return the current value of a HMAFil object error flag using

     Vint vdm_HMAFilError (vdm_HMAFil *HMAFil)


Table of Contents , HMAFil

NAME

vdm_HMAFilDataFun - fill DataFun object

C SPECIFICATION

void vdm_HMAFilDataFun (vdm_HMAFil *HMAFil,
                        vdm_DataFun *datafun);

INPUT ARGUMENTS

HMAFil       Pointer to HMAFil object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , HMAFil

NAME

vdm_HMAFilAbort - set abort flag

C SPECIFICATION

void vdm_HMAFilAbort (vdm_HMAFil *HMAFil)

INPUT ARGUMENTS

HMAFil      Pointer to HMAFil object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_HMAFilSetFunction.


Table of Contents , HMAFil

NAME

vdm_HMAFilSetFunction - set a call back functions

C SPECIFICATION

void vdm_HMAFilSetFunction (vdm_HMAFil *HMAFil,
                            Vint funtype,
                            void (*function)(vdm_HMAFil*, Vobject*),
                            Vobject *object)

INPUT ARGUMENTS

HMAFil       Pointer to HMAFil object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.46 Altair Engineering H3D File - H3DLib

The Altair H3D file contains model and results data. The file format is a proprietary format developed by Altair Enginerring and requires a toolkit from Altair.

The methods associated with a H3DLib object are the following.

Instance a H3DLib object using vdm_H3DLibBegin. Once instanced set pointers to abstract data functions using vdm_H3DLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_H3DLibSetFunction.

The PARTID.E dataset is set to the component identifier.

Each results dataset is appended with two identifiers, the first is the subcase id and the second is the simulation id.

Table of Contents

5.47 Function Descriptions

The currently available H3DLib functions are described in detail in this section.


Table of Contents , H3DLib

NAME

*vdm_H3DLibBegin - create an instance of a H3DLib object

C SPECIFICATION

vdm_H3DLib *vdm_H3DLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created H3DLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a H3DLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a H3DLib object using

     void vdm_H3DLibEnd (vdm_H3DLib *h3dlib)

Return the current value of a H3DLib object error flag using

     Vint vdm_H3DLibError (vdm_H3DLib *h3dlib)


Table of Contents , H3DLib

NAME

vdm_H3DLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_H3DLibDataFun (vdm_H3DLib *h3dlib,
                        vdm_DataFun *datafun);

INPUT ARGUMENTS

h3dlib       Pointer to H3DLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , H3DLib

NAME

vdm_H3DLibAbort - set abort flag

C SPECIFICATION

void vdm_H3DLibAbort (vdm_H3DLib *h3dlib)

INPUT ARGUMENTS

h3dlib      Pointer to H3DLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_H3DLibSetFunction.


Table of Contents , H3DLib

NAME

vdm_H3DLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_H3DLibSetFunction (vdm_H3DLib *h3dlib,
                            Vint funtype,
                            void (*function)(vdm_H3DLib*, Vobject*),
                            Vobject *object)

INPUT ARGUMENTS

h3dlib       Pointer to H3DLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.48 MSC/Marc Post File - MarcLib

The Marc post file format may be either an ASCII or binary file which results from an execution of Marc from MSC Software. The ASCII file format usually contains a .t19 suffix, the binary file contains a .t16 suffix.

The methods associated with a MarcLib object are the following.

Instance a MarcLib object using vdm_MarcLibBegin. Once instanced set pointers to abstract data functions using vdm_MarcLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_MarcLibSetFunction.

The interface reads all element types, node coordinates and coordinate systems. All node and element sets are read. Elements contained in contact bodies are placed in element sets. The PARTID.E dataset is set to the finite element type. Use the convention, VDM_CONVENTION_EIP to generate elemeent integration point results.

Each results dataset name is appended with the values of the "increment number" and the "sub-increment number". These numbers are incremented by one.

Supported Solution Variables, Results

Post Code
Dataset
1-6
E
7
E.[EQUIV,PLAST]
8
E.[EQUIV,CREEP]
9
TEMP.[TOT]
10
TEMP.[INC]
11-16
S
17
S.[VONMISES]
18
S.[MEAN,NORMAL]
19
USER
20
THICKNESS
21-26
E.[PLAST]
27
E.[EQUIV,PLAST]
28
E_RATE.[PLAST]
29
UNKNOWN.[SecndStateVar]
30
UNKNOWN.[FormLimPar]
31-36
E.[CREEP]
37
E.[EQUIV,CREEP]
38
E.[SWELLING]
39
UNKNOWN.[ThirdStateVar]
41-46
S.[CAUCHY]
47
S.[EQUIV,CAUCHY]
48
SE_DENSITY
49
E.[Thickness]
51-56
S.[HARMONIC]
57
S.[EQUIV,HARMONIC]
58
SE_DENSITY.[ELAST]
59
S.[EQUIV,YIELD]
60
S.[EQUIV,YIELD,CurTemp]
61-66
S.[HARMONIC]
67
S.[EQUIV,HARMONIC]
68
SE_DENSITY.[PLAST]
69
VOLUME
71-76
E.[THERMAL]
78
VOLUME.[Original]
79
UNKNOWN.[Grain size]
81-86
E.[CRACKING]
87
VOLT
88
J
89
HEAT
91-103
FAIL_INDEX
108
S.[INTERLAMINAR,1]
109
S.[INTERLAMINAR,2]
111-116
S.[PrefSys]
121-126
E.[ELAST]
127
E.[EQUIV,ELAST]
128
E.[MAX,Eng]
129
E.[MIN,Eng]
130
VOLT
131-133
ELEC_FIELD
134-136
ELEC_FLUX.[Displacement]
137-139
FORCE.[LORENTZ]
140
MAG_POT
141-143
MAG_FIELD.[Induction]
144-146
MAG_FLUX.[Intensity]
147-149
J_DENSITY
151-153
ELEC_FIELD
154-156
ELEC_FLUX.[Displacement]
157-159
FORCE.[LORENTZ]
161-163
MAG_FIELD.[Induction]
164-166
MAG_FLUX.[Intensity]
167-169
J_DENSITY
171
POROSITY
172
VOID_RATIO
173
PRES.[PORE]
174
PRES.[Preconsolidation]
175
E_RATE.[EQUIV,Viscoplastic]
176
DENS.[REL]
177
VOLUME.[Fraction,Damage]
180
TEMP.[TOT]
181-183
TEMP_GRAD
184-186
HEAT_FLUX
190
PRES.[TOT]
191-193
PRES_GRAD
194-196
MASS_FLUX
241
PRES.[GASKET]
242
CLOSURE.[GASKET]
243
CLOSURE.[GASKET,PLAST]
261-263
UNKNOWN.[BeamAxis]
264-269
SFM
270
UNKNOWN.[Bimoment]
271
DENS.[Pyrol,Solid]
272
DENS.[Pyrol,Gas]
273
DENS.[FLUID]
301-306
E.[TOT]
311-316
S
321-326
E.[PLAST]
331-336
E.[CREEP]
341-346
S.[CAUCHY]
351-356
S.[HARMONIC]
361-366
S.[HARMONIC]
371-376
E.[THERMAL]
381-386
E.[CRACKING]
391-396
S.[PrefDir]
401-406
E.[ELAST]
411-416
S.[GlobalSys]
421-426
E.[ELAST,GlobalSys]
431-436
E.[PLAST,GlobalSys]
441-446
E.[CREEP,GlobalSys]
451-456
E_RATE
461-466
E.[ELAST,PrefDir]
471-476
S.[PK,Rebar]
481-486
S.[CAUCHY]
487
UNKNOWN,[RebarAngle]
501
S,[INTERLAMINAR,NORMAL]
511
S,[INTERLAMINAR,SHEAR]
531
VOLUME.[FractionMartensite]
541-546
E.[PhaseTrans]
547
E.[EQUIV,PhaseTrans]
548
E.[EQUIV,TWIN]
549
E.[EQUIV,TRIP]
557
S.[YIELD,MultiphaseAgg]
561-563
ELEC_FIELD
564-566
ELEC_FLUX,Displacement]
567-569
FORCE.[LORENTZ]
571-573
MAG_FIELD.[Induction]
574-576
MAG_FLUX,[Intensity]
577-579
J_DENSITY
651
E.[EQUIV,PLAST,MultiphaseAgg]
652
E.[EQUIV,PLAST,Austenite]
653
E.[EQUIV,PLAST,Martensite]
657
S.[YIELD,MultiphaseAgg]

Quantity Identifier
Dataset
1,2
D
3,4
XF
5,6
R
7
V.[FLUID]
8
PRES.[FLUID]
9
XF.[FLUID]
10
R.[FLUID]
11
PRES.[SOUND]
12
UNKNOWN.[ExternalSoundSource]
13
UNKNOWN.[ReactionSoundSource]
14
TEMP
15
XF_HEAT_FLOW
16
R_HEAT_FLOW
17
ELEC_POT
18
XF_Q
19
R_Q
20
MAG_POT
21
XF_J
22
R_J
23
PRES.[PORE]
24
XF_MASS_FLOW
25
R_MASS_FLOW
26
PRES.[Bearing]
27
R.[Bearing]
28,29
V
30,31
A
32,33
MASS.[Modal]
34
PRES.[CONTACT]
35
FORCE.[NORMAL,CONTACT]
36
TRAC.[CONTACT,Friction]
37
FORCE.[CONTACT,Friction]
38
STAT.[CONTACT]
39
UNKNOWN.[CONTACT,TouchedBody]
40
UNKNOWN.[HerrmannVar]
46
R.[Tying]
47
R.[Coulomb]
48
R.[Tying]
49
S.[Generalized]

Table of Contents

5.49 Function Descriptions

The currently available MarcLib functions are described in detail in this section.


Table of Contents , MarcLib

NAME

*vdm_MarcLibBegin - create an instance of a MarcLib object

C SPECIFICATION

vdm_MarcLib *vdm_MarcLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created MarcLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a MarcLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a MarcLib object using

     void vdm_MarcLibEnd (vdm_MarcLib *marclib)

Return the current value of a MarcLib object error flag using

     Vint vdm_MarcLibError (vdm_MarcLib *marclib)


Table of Contents , MarcLib

NAME

vdm_MarcLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_MarcLibDataFun (vdm_MarcLib *marclib,
                         vdm_DataFun *datafun);

INPUT ARGUMENTS

marclib      Pointer to MarcLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , MarcLib

NAME

vdm_MarcLibAbort - set abort flag

C SPECIFICATION

void vdm_MarcLibAbort (vdm_MarcLib *marclib)

INPUT ARGUMENTS

marclib      Pointer to MarcLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_MarcLibSetFunction.


Table of Contents , MarcLib

NAME

vdm_MarcLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_MarcLibSetFunction (vdm_MarcLib *marclib,
                             Vint funtype,
                             void (*function)(vdm_MarcLib*, Vobject*),
                             Vobject *object)

INPUT ARGUMENTS

marclib      Pointer to MarcLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.50 Memory object - MemLib

This module supports read and write operations to a native memory object. Any VdmTools dataset may be written to such a memory object The methods associated with a MemLib object are the following.

Instance a MemLib object using vdm_MemLibBegin. Once instanced set pointers to abstract data functions using vdm_MemLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_MemLibSetFunction.

Use the function vdm_MemLibStreamNum to query for the number of bytes in the memory object. Use vdm_MemLibStream to copy the data from MemLib to a user allocated memory object. Use the function vdm_MemLibGetInteger to query for the memory object version number and the date and time of initial creation and update.

Table of Contents

5.51 Function Descriptions

The MemLib functions are described in detail in this section.


Table of Contents , MemLib

NAME

*vdm_MemLibBegin - create an instance of a MemLib object

C SPECIFICATION

vdm_MemLib *vdm_MemLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created MemLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a MemLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a MemLib object using

     void vdm_MemLibEnd (vdm_MemLib *memlib)

Return the current value of a MemLib object error flag using

     Vint vdm_MemLibError (vdm_MemLib *memlib)


Table of Contents , MemLib

NAME

vdm_MemLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_MemLibDataFun (vdm_MemLib *memlib,
                        vdm_DataFun *datafun);

INPUT ARGUMENTS

memlib       Pointer to MemLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , MemLib

NAME

vdm_MemLibAbort - set abort flag

C SPECIFICATION

void vdm_MemLibAbort (vdm_MemLib *memlib)

INPUT ARGUMENTS

memlib      Pointer to MemLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_MemLibSetFunction.


Table of Contents , MemLib

NAME

vdm_MemLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_MemLibSetFunction (vdm_MemLib *memlib,
                            Vint funtype,
                            void (*function)(vdm_MemLib*, Vobject*),
                            Vobject *object)

INPUT ARGUMENTS

memlib       Pointer to MemLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.


Table of Contents , MemLib

NAME

vdm_MemLibStreamNum - query length of memory object in bytes

C SPECIFICATION

void vdm_MemLibStreamNum (vdm_MemLib *memlib,
                          Vlong *nbytes)

INPUT ARGUMENTS

memlib       Pointer to MemLib object.

OUTPUT ARGUMENTS

nbytes       Length of memory object in bytes

DESCRIPTION

Query the number of bytes in memory object.


Table of Contents , MemLib

NAME

vdm_MemLibStream - copy to user memory object

C SPECIFICATION

void vdm_MemLibStream (vdm_MemLib *memlib,
                       void *buff)

INPUT ARGUMENTS

memlib       Pointer to MemLib object.
buff         Pointer to user memory object

OUTPUT ARGUMENTS

None

DESCRIPTION

Copy data to user memory object at pointer buff.


Table of Contents , MemLib

NAME

vdm_MemLibGetInteger - get version, time and date stamps

C SPECIFICATION

void vdm_MemLibGetInteger (vdm_MemLib *memlib,
                           Vint type,
                           Vint param[])

INPUT ARGUMENTS

memlib       Pointer to MemLib object.
type         Type of integer information to query
             =MEMLIB_VERSION       File version
             =MEMLIB_CREATEDATE    Creation date
             =MEMLIB_CREATETIME    Creation time
             =MEMLIB_UPDATEDATE    Update date
             =MEMLIB_UPDATETIME    Update time

OUTPUT ARGUMENTS

param        Returned integer information

ERRORS

SYS_ERROR_ENUM is generated if an improper type is specified.

DESCRIPTION

Query for integer information. The integer query MEMLIB_VERSION returns a version number. The parameters MEMLIB_CREATEDATE and MEMLIB_CREATETIME each return 3 integers indicating the day,month,year and second,minute,hour of initial creation of the file. The parameters MEMLIB_UPDATEDATE and MEMLIB_UPDATETIME each return 3 integers indicating the day,month,year and second,minute,hour of last update of the file.

Table of Contents

5.52 MSC/NASTRAN bulk data input file - NASFil

The NASTRAN bulk data file is a text file which contains the input description of a finite element model for the NASTRAN finite element program.

The methods associated with a NASFil object are the following.

Instance a NASFil object using vdm_NASFilBegin. Once instanced set pointers to abstract data functions using vdm_NASFilDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_NASFilSetFunction.

This interface only produces datasets associated with the finite element model, no results datasets are produced. The element types commonly associated with structural and thermal analysis are supported. The PARTID.E dataset is set to the property id. The NASTRAN bulk data commands have been extended by various vendors who have extended the "classic" NASTRAN commands. The NASFil module supports many of these extensions. The interface currently recognizes the following input commands.

Supported Commands
Miscellaneous
Description
INCLUDE
Read from specified file
Executive Control
Description
BEGIN BULK
Begin bulk data section
SOL
Define a solution type
CEND
End of executive control
Case Control
Description
SETS
SET
Create node or element set
ANALYSIS
SUBCASE
Create solution property case
LABEL
TITLE
SUBTITLE
Define label, title and subtitle strings
LOAD
MPC
SPC
TEMP
Select load case, multipoint constraint case, or single point constraint case
METHOD
NLPARM
Select EIGRL or NLPARM bulk data entries
ACCELERATION
DISPLACEMENT
ESE
FLUX
FORCE
GPFORCE
MPCFORCES
OLOAD
THERMAL
SPCFORCES
STRAIN
STRESS
VELOCITY
Define output request
Nodes, Elements, Coordinate Systems
Description
GRDSET
Set GRID defaults
GRID
Create node
SPOINT
Create scalar node
BAROR
BEAMOR
Set CBAR and CBEAM defaults
CBAR
CBEAM
CBEAM3 (MSC)
CBEND
CTUBE
Create 3D beam element
CDAMP1
CDAMP2
CDAMP3
CDAMP4
Create scalar spring dashpot element
CELAS1
CELAS2
CELAS3
CELAS4
Create scalar spring dashpot element
CBUSH CBUSH1D
CFAST
CWELD
CVISC
Create spring dashpot element
CGAP
Create gap element
CHBDYE
CHBDYG
CHBDYP
Create interface element
CQUAD
CQUADX
CQUADX4 CQUADX8 (NX)
CTRAX3 CTRAX6 (NX)
CTRIAX
CTRIAX6
Create 2D solid element
CPLSTN3 CPLSTN4 (NX)
CPLSTN6 CPLSTN8 (NX)
Create 2D plane strain element
CPLSTS3 CPLSTS4 (NX)
CPLSTS6 CPLSTS8 (NX)
Create 2D plane stress element
CHEXA
CPENTA
CPYRA (Optistruct)
CPYRAM
CTETRA
Create 3D solid element
CQUAD4
CQUAD8
CQUADR
CTRIA3
CTRIA6
CTRIAR
Create 3D shell element
CSHEAR
Create 3D membrane element
CONROD
CROD
Create 3D truss or beam element
CMASS1
CMASS2
CMASS3
CMASS4
Create scalar mass element
CONM1
CONM2
Create mass element
CONV
Create interface element
PLOTEL3 PLOTEL4 (NX)
PLOTEL6 PLOTEL8 (NX)
PLOTHEX PLOTPEN (NX)
PLOTPYR PLOTTET (NX)
PLOTEL
Create plot element
RBE1 RBE2 RBE3
RBAR
RJOINT
RROD
RSPLINE
RTRPLT
Create rigid element
CORD1C CORD1R CORD1S
CORD2C CORD2R CORD2S
CORD3R CORD4R (Optistruct)
Create coordinate system
Sets and Surfaces
Description
GROUP (NX)
SET (Optistruct)
Create node or element set
BSURF
BSURFS (NX)
SURF (Optistruct)
Create element face surface
Element Properties
Description
PBAR
PBARL
PBEAM
PBEAM3 (MSC)
PBEAML
PTUBE
Create beam property
PCOMP
PCOMPG
PCOMPG1
PCOMPS
Create shell or solid composite property
PCONV
PHBDY
Create interface property
PBUSH
PDAMP
PELAS
PFAST
PVISC
PWELD
Create spring dashpot property
PGAP
Create gap property
PLPLANE
PLSOLID
PSOLID
Create solid property
PMASS
Create mass property
PROD
Create truss or beam property
PSHEAR
Create membrane property
PSHELL
Create shell property
Material Properties
Description
MAT1
MAT2
MAT3
MAT8
MAT9
MATT1
MATT2
MATT3
MATT9
Create linear elastic possibly temperature dependent material property
MAT4
MAT5
MATT4
MATT5
Create linear heat transfer possibly temperature dependent material property
MATHP
Create hyperelastic material property
TABLEM1
TABLEM2
TABLEM3
Create material property tables
RADM
Create radiation material property
Loads, Initial Conditions
Description
FORCE
FORCE1
FORCE2
MOMENT
MOMENT1
MOMENT2
Define concentrated force or moment
PLOAD
PLOADX1
PLOAD2
PLOAD4
Define distributed loading
GRAV
RFORCE
Define acceleration loading
QBDY1
QBDY2
QBDY3
Define distributed heat flux loading
QVOL
Define volumetric heat loading
RADBC
Define radiation condition
SLOAD
Define concentrated heat loading
LOAD
Create load case
TEMP
TEMPD
Define nodal temperatures
Restraints
Description
SPC
SPC1
SPCD
SUPORT
Define single point restraint
SPCADD
Create single point restraint case
MPC
Define multipoint restraint
MPCADD
Create multipoint constraint case
Contact, Tie, Cyclic Symmetry
Description
CYCSET (NX)
Create cyclic symmetry pair
TIE (Optistruct)
Create tied contact pair
Solution and Control
Description
NLPARM
Define nonlinear solution properties
EIGRL
Define eigenvalue solution properties

Table of Contents

5.53 Function Descriptions

The currently available NASFil functions are described in detail in this section.


Table of Contents , NASFil

NAME

*vdm_NASFilBegin - create an instance of a NASFil object

C SPECIFICATION

vdm_NASFil *vdm_NASFilBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created NASFil object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a NASFil object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a NASFil object using

     void vdm_NASFilEnd (vdm_NASFil *nasfil)

Return the current value of a NASFil object error flag using

     Vint vdm_NASFilError (vdm_NASFil *nasfil)


Table of Contents , NASFil

NAME

vdm_NASFilDataFun - fill DataFun object

C SPECIFICATION

void vdm_NASFilDataFun (vdm_NASFil *nasfil,
                        vdm_DataFun *datafun);

INPUT ARGUMENTS

nasfil       Pointer to NASFil object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , NASFil

NAME

vdm_NASFilAbort - set abort flag

C SPECIFICATION

void vdm_NASFilAbort (vdm_NASFil *nasfil)

INPUT ARGUMENTS

nasfil      Pointer to NASFil object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_NASFilSetFunction.


Table of Contents , NASFil

NAME

vdm_NASFilSetFunction - set a call back functions

C SPECIFICATION

void vdm_NASFilSetFunction (vdm_NASFil *nasfil,
                            Vint funtype,
                            void (*function)(vdm_NASFil*, Vobject*),
                            Vobject *object)

INPUT ARGUMENTS

nasfil       Pointer to NASFil object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.54 Writing NASTRAN Input Files

The NASFil module also supports the writing of NASTRAN input files. Finite element model entities must be contained in a VisTools Model object. The LMan module function vdm_LManSaveModel is used to perform the actual file writing. The file may also be written directly using the Model object function vis_ModelWrite. Set the GProp object value GPROP_EXPORT_VENDOR to control the vendor specific format to be used for some entities such as pyramid elements and surface and tie constraints. The interface currently writes the following input commands.

Supported Commands
Executive Control
Description
BEGIN BULK
Begin bulk data section
SOL
Define a solution type
CEND
End of executive control
ENDDATA
Terminate input deck
Case Control
Description
SUBCASE
Define solution property case
LABEL
TITLE
SUBTITLE
Define label, title and subtitle strings
PARAM
Define various solution parameters
LOAD
MPC
SPC
TEMP
Define load case, multipoint constraint case, or single point constraint case
METHOD
NLPARM
Define EIGRL or NLPARM bulk data entries
OUTPUT
DISPLACEMENT
ESE
FLUX
FORCE
GPFORCE
MPCFORCES
OLOAD
THERMAL
SPCFORCES
STRAIN
STRESS
Define output request
Nodes, Elements, Coordinate Systems
Description
GRID
Define node
SPOINT
Define scalar node
CBUSH
CBEAM
Define beam element
CELAS1
Define scalar spring dashpot element
CGAP
Define gap element
CHBDYE
CHBDYG
Define interface element
CQUADX
CTRIAX
Define 2D solid element
CHEXA
CPENTA
CPYRA (Optistruct)
CPYRAM
CTETRA
Define 3D solid element
CQUAD4
CQUAD8
CTRIA3
CTRIA6
Define 3D shell element
CROD
Define 3D truss or beam element
CONM1
CONM2
Define mass element
CONV
Define interface element
RBE2
RBE3
RROD
RBAR
Define rigid element
CORD2C
CORD2R
CORD2S
Define coordinate system
Element Properties
Description
PROD
Define truss property
PBUSH
PBAR
PBARL
PBEAM
PBEAML
Define beam property
PCONV
Define interface property
PELAS
Define spring dashpot property
PGAP
Define gap property
PSOLID
Define solid property
PSHEAR
Define membrane property
PCOMP
Define shell composite property
PSHELL
Define shell property
Material Properties
Description
MAT1
MAT2
MAT8
MAT9
Define linear elastic material property
MAT4
Define linear heat transfer material property
Loads, Initial Conditions
Description
FORCE
MOMENT
SLOAD
Define concentrated force or moment
PLOAD2
PLOAD4
Define distributed loading
RFORCE
GRAV
Define acceleration loading
QBDY1
QBDY2
Define distributed heat flux loading
QVOL
Define volumetric heat loading
TEMP
TEMPD
Define nodal temperatures
Restraints
Description
SPC
Define single point restraint
MPC
Define multipoint restraint
Solution and Control
Description
NLPARM
Define nonlinear solution properties
EIGRL
Define eigenvalue solution properties

Table of Contents

5.55 NASTRAN OUTPUT2, .xdb and .h5 data files - NASLib

The NASTRAN finite element program creates a number of results data files depending upon the specific vendor of the NASTRAN program. The NASTRAN OUTPUT2 data file is a binary results database produced during an execution of the NASTRAN finite element program.

The methods associated with a NASLib object are the following.

Instance a NASLib object using vdm_NASLibBegin. Once instanced set pointers to abstract data functions using vdm_NASLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_NASLibSetFunction.

The contents of the OUTPUT2 data file varies considerably depending upon the data blocks specified to be output. There are a number of commercial versions of NASTRAN, noteably MSC/NASTRAN and NX/NASTRAN. There are also a number of commercial finite element programs that write data in .op2 file format. Complex results are supported where applicable, both real/imaginary and magnitude/phase. The PARTID.E dataset is set to the property id. Use the convention, VDM_CONVENTION_STRESSINVARIANT to generate vonmises stress results for quadrilateral shell element stress/strain. Use the convention, VDM_CONVENTION_NOINTERLAMINAR to inhibit generation of interlaminar ply stress/strain results.

Supported Data Blocks, Model

Nodes, Coordinate Systems
Data Block Name
Description
BGPDT
BGPDTS
BASIC GRID POINT DEFINITION TABLE
GPL
GPLS
GRID POINT LIST
GPDT
GPDTS
GRID POINT DEFINITION TABLE
GEOM1
GEOM1S
GEOM1X
TABLE OF BULK DATA ENTRY IMAGES RELATED TO GEOMETRY
CSTM
COORDINATE SYSTEM TRANSFORMATION MATRICES TABLE
Elements
Data Block Name
Description
ECT
ELEMENT CONNECTIVITY TABLE
GEOM2
GEOM2S
GEOM2X
TABLE OF BULK DATA ENTRIES RELATED TO ELEMENT CONNECTIVITY
GEOM4
GEOM4S
GEOM4X
TABLE OF BULK DATA ENTRY IMAGES RELATED TO RIGID ELEMENT CONNECTIVITY
Node and Element Sets
Data Block Name
Description
CASECC
EDT
TABLE OF BULK DATA ENTRY IMAGES RELATED TO NODE AND ELEMENT SETS
Loads
Data Block Name
Description
GEOM3
GEOM3S
GEOM3X
TABLE OF BULK DATA ENTRY IMAGES RELATED TO STATIC AND THERMAL LOADS
Restraints
Data Block Name
Description
GEOM4
GEOM4S
TABLE OF BULK DATA ENTRY IMAGES RELATED TO CONSTRAINTS
Element Properties
Data Block Name
Description
EPT
TABLE OF BULK DATA ENTRY IMAGES RELATED TO ELEMENT PROPERTIES
Material Properties
Data Block Name
Description
MPT
TABLE OF BULK DATA ENTRY IMAGES RELATED TO MATERIAL PROPERTIES
Solution Properties
Data Block Name
Description
CASECC
PVT
TABLE OF BULK DATA ENTRY IMAGES RELATED TO SOLUTION PROPERTIES

Each results dataset is appended with two identifiers, the first is the subcase id and the second is a mode or step id. For buckling and eigenvalue analysis the second identifier is a mode id. For frequency response and transient analysis the second identifier is a step id.

Supported Data Blocks, Results

Node Results
Data Block Name
Description Dataset Root.[Qualifier]
OUGV1
OUGV2
BOUGV1
OUGV1PAT
OUBGV1
OUPV1
OPHIG
BOPHIG
OUGPSD1
OUTPUT DISPLACEMENT VECTOR D
D.[PSD]
D.[DEFORM]
V
V.[PSD]
V.[DEFORM]
A
A.[PSD]
A.[DEFORM]
TEMP
H
H_DOT
TOUGV1
OUTPUT TEMPERATURE TEMP
H
H_DOT
OPG1
OPG2
OPP1
OUTPUT LOAD VECTOR XF
XF.[PSD]
XF_HEAT_FLOW
OQG1
OQG2
OQBG1
OBQG1
OQP1
OQMG1
OQMG2
OUTPUT SPC FORCES R
R.[PSD]
R.[MPC]
R_HEAT_FLOW
OBG1
OQGGF1
OUTPUT GLUE FORCES PRES.[GLUE]
TRAC.[GLUE]
FORCE.[GLUE]
OBC1
OQGCF1
OFCON3D
OUTPUT CONTACT FORCES PRES.[CONTACT]
TRAC.[CONTACT]
FORCE.[CONTACT]
STAT.[CONTACT]
FORCE.[CONTACT,NORMAL]
FORCE.[CONTACT,FRICTION]
OSPDSI1
OSPDS1
OUTPUT CONTACT SEPARATION SEP.[CONTACT,INITIAL]
SEP.[CONTACT,FINAL]
Element Results
Data Block Name
Description Dataset Root.[Qualifier]
ONRGY1
OEKE1
OUTPUT ELEMENT STRAIN and KINETIC ENERGY SE
SE_PERCENT
SE_DENSITY
KE
KE_DENSITY
OES1X
OES1X1
OES1
OES2
OESB1
OBES1
OESNLXR
OESPSD1
OESRMS1
OESNO2
OESPSD2
OESRMS2
OUTPUT ELEMENT STRESS/STRAIN S
S.[PSD]
S.[RMS]
S.[NOZ]
S.[AXIAL]
S.[TORSION]
S.[VONVISES]
S.[NONLIN]
E.[NONLIN]
E.[EQUIV,PLAST]
E.[EQUIV,CREEP]
SAFE_FACT.[COMP]
SAFE_FACT.[TENS]
FAIL_INDEX
SD
SF
OSTR1
OSTR2
OSTR1X
OUTPUT ELEMENT STRAIN E
E.[PSD]
SEK
OEF1X
OEF1
OEF2
OEFB1
OBEF1
HOEF1
OUTPUT ELEMENT FORCE SFM
SFM.[PSD]
HEAT_FLUX
TEMP_GRAD
HEAT_FLUX.[TOT]
OES1C
OUTPUT COMPOSITE ELEMENT STRESS S.[PLY]
OSTR1C
OUTPUT COMPOSITE ELEMENT STRAIN E.[PLY]
OEFIT
OUTPUT COMPOSITE FAILURE INDICES FAIL_INDEX.[PLY]
FAIL_INDEX.[INTERLAMINAR]
OESRT
OUTPUT COMPOSITE STRENGTH RATIOS STRENGTH_RATIO.[PLY]
STRENGTH_RATIO.[INTERLAMINAR]
OGPFB1
OUTPUT ELEMENT GRID POINT FORCE EN_FORC
R.[GPF]
R.[MPC.GPF]
XF.[GPF]
TF.[GPF]
OGK1
OUTPUT GASKET RESULTS PRES.[GASKET]
CLOSURE.[GASKET]
CLOSURE.[GASKET,PLAST]
S.[GASKET.YIELD]
STAT.[GASKET]
OSHT1
OUTPUT SHELL THICKNESS THICKNESS
OERPEL1
OUTPUT ELEMENT EQUIVALENT RADIATED POWER POWER
POWER_DENSITY

The nonzero stress/strain and force/moment component vary for each element type. The nonzero components are listed below. Any element type not listed has all zero components.

Stress and Strain Components
Element Type
Components
Solid (3D)
xx, yy, zz, xy, yz, zx
Solid (2D Axisymmetric, CTRIAX6)
xx, yy, zz, 0, 0, zx
Shell
xx, yy, 0, xy, 0, 0
Beam
SpringDashpot
xx, 0, 0, 0, 0, 0

Force and Moment Components
Element Type - Element Spec
Components
Shell
Nxx, Nyy, Nxy, Mxx, Myy, Mxy, Qxz, Qyz
Beam - Standard
Nxx, Myy, Mzz, Torque, Qxy, Qzx
Beam - Rod
Nxx, 0, 0, Torque, 0, 0
SpringDashpot
Nxx

Table of Contents

5.56 Function Descriptions

The currently available NASLib functions are described in detail in this section.


Table of Contents , NASLib

NAME

*vdm_NASLibBegin - create an instance of a NASLib object

C SPECIFICATION

vdm_NASLib *vdm_NASLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created NASLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a NASLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a NASLib object using

     void vdm_NASLibEnd (vdm_NASLib *naslib)

Return the current value of a NASLib object error flag using

     Vint vdm_NASLibError (vdm_NASLib *naslib)


Table of Contents , NASLib

NAME

vdm_NASLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_NASLibDataFun (vdm_NASLib *naslib,
                        vdm_DataFun *datafun);

INPUT ARGUMENTS

naslib       Pointer to NASLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , NASLib

NAME

vdm_NASLibAbort - set abort flag

C SPECIFICATION

void vdm_NASLibAbort (vdm_NASLib *naslib)

INPUT ARGUMENTS

naslib      Pointer to NASLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_NASLibSetFunction.


Table of Contents , NASLib

NAME

vdm_NASLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_NASLibSetFunction (vdm_NASLib *naslib,
                            Vint funtype,
                            void (*function)(vdm_NASLib*, Vobject*),
                            Vobject *object)

INPUT ARGUMENTS

naslib       Pointer to NASLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.57 Writing NASTRAN OUTPUT2 data files

The NASLib module also supports a limited capability to write finite element model entities and results to NASTRAN OUTPUT2 data file format. Finite element model entities and results must be contained in VisTools Model and State objects. The LMan module functions vdm_LManSaveModel and vdm_LManSaveState are used to perform the actual file writing. The interface currently writes the following entities as records on data blocks: Table of Contents

5.58 Native file - NatLib

The native file format is a VdmTools file format, it may be based on either a proprietary file organization or the publicly available HDF5 file format. The native file format supports both read and write operations. Any VdmTools dataset may be written to a native file. The methods associated with a NatLib object are the following.

Instance a NatLib object using vdm_NatLibBegin. Once instanced set pointers to abstract data functions using vdm_NatLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_NatLibSetFunction.

Native files names should be denoted by a .vdm suffix if using the proprietary file organization, SYS_NATIVE, and a .vh5 suffix if using the HDF5 file organization, SYS_NATIVE_HDF5. Use the function vdm_NatLibGetInteger to query for the native file version number and the date and time of initial creation and update.

Table of Contents

5.59 Function Descriptions

The NatLib functions are described in detail in this section.


Table of Contents , NatLib

NAME

*vdm_NatLibBegin - create an instance of a NatLib object

C SPECIFICATION

vdm_NatLib *vdm_NatLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created NatLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a NatLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a NatLib object using

     void vdm_NatLibEnd (vdm_NatLib *natlib)

Return the current value of a NatLib object error flag using

     Vint vdm_NatLibError (vdm_NatLib *natlib)


Table of Contents , NatLib

NAME

vdm_NatLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_NatLibDataFun (vdm_NatLib *natlib,
                        vdm_DataFun *datafun);

INPUT ARGUMENTS

natlib       Pointer to NatLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , NatLib

NAME

vdm_NatLibAbort - set abort flag

C SPECIFICATION

void vdm_NatLibAbort (vdm_NatLib *natlib)

INPUT ARGUMENTS

natlib      Pointer to NatLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_NatLibSetFunction.


Table of Contents , NatLib

NAME

vdm_NatLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_NatLibSetFunction (vdm_NatLib *natlib,
                            Vint funtype,
                            void (*function)(vdm_NatLib*, Vobject*),
                            Vobject *object)

INPUT ARGUMENTS

natlib       Pointer to NatLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.


Table of Contents , NatLib

NAME

vdm_NatLibGetInteger - get version, time and date stamps

C SPECIFICATION

void vdm_NatLibGetInteger (vdm_NatLib *natlib,
                           Vint type,
                           Vint param[])

INPUT ARGUMENTS

natlib       Pointer to NatLib object.
type         Type of integer information to query
             =NATLIB_VERSION       File version
             =NATLIB_CREATEDATE    Creation date
             =NATLIB_CREATETIME    Creation time
             =NATLIB_UPDATEDATE    Update date
             =NATLIB_UPDATETIME    Update time

OUTPUT ARGUMENTS

param        Returned integer information

ERRORS

SYS_ERROR_ENUM is generated if an improper type is specified.

DESCRIPTION

Query for integer information. The integer query NATLIB_VERSION returns a version number. The parameters NATLIB_CREATEDATE and NATLIB_CREATETIME each return 3 integers indicating the day,month,year and second,minute,hour of initial creation of the file. The parameters NATLIB_UPDATEDATE and NATLIB_UPDATETIME each return 3 integers indicating the day,month,year and second,minute,hour of last update of the file.

Table of Contents

5.60 OBJ file - OBJFil

The OBJ format is an ASCII text file. It is a list of vertices, vertex normals, points, lines and faces.

The methods associated with a OBJFil object are the following.

Instance a OBJFil object using vdm_OBJFilBegin. Once instanced set pointers to abstract data functions using vdm_OBJFilDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_OBJFilSetFunction.

In an OBJ file, points, lines and faces are translated as elements. All faces are converted to 3-node trianglar elements assuming a triangle fan. Lines are converted to 2-node line elements. Points are converted to point elements. The PARTID.E dataset is set to group index if groups exist, other it is set to the element dimension.

Table of Contents

5.61 Function Descriptions

The currently available OBJFil functions are described in detail in this section.


Table of Contents , OBJFil

NAME

*vdm_OBJFilBegin - create an instance of a OBJFil object

C SPECIFICATION

vdm_OBJFil *vdm_OBJFilBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created OBJFil object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a OBJFil object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a OBJFil object using

     void vdm_OBJFilEnd (vdm_OBJFil *objfil)

Return the current value of a OBJFil object error flag using

     Vint vdm_OBJFilError (vdm_OBJFil *objfil)


Table of Contents , OBJFil

NAME

vdm_OBJFilDataFun - fill DataFun object

C SPECIFICATION

void vdm_OBJFilDataFun (vdm_OBJFil *objfil,
                        vdm_DataFun *datafun);

INPUT ARGUMENTS

objfil       Pointer to OBJFil object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , OBJFil

NAME

vdm_OBJFilAbort - set abort flag

C SPECIFICATION

void vdm_OBJFilAbort (vdm_OBJFil *objfil)

INPUT ARGUMENTS

objfil      Pointer to OBJFil object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_OBJFilSetFunction.


Table of Contents , OBJFil

NAME

vdm_OBJFilSetFunction - set a call back functions

C SPECIFICATION

void vdm_OBJFilSetFunction (vdm_OBJFil *objfil,
                            Vint funtype,
                            void (*function)(vdm_OBJFil*, Vobject*),
                            Vobject *object)

INPUT ARGUMENTS

objfil       Pointer to OBJFil object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.62 OpenFOAM database - OpenFOAMLib

The OpenFOAM database is a top directory consisting of subdirectories and files containing analysis model and results data. The top directory is called case. The key file must be the controlDict file located in the system directory. The path to the key file must include the name of the top case directory.

The methods associated with a OpenFOAMLib object are the following.

Instance a OpenFOAMLib object using vdm_OpenFOAMLibBegin. Once instanced set pointers to abstract data functions using vdm_OpenFOAMLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_OpenFOAMLibSetFunction.

Each dataset in the state data section has a Time attribute which corresponds to the time specified by the subdirectories of case where results are found. The data source for the result is also presented as an attribute, and corresponds to the complete file path.

Each OpenFOAM result file contains a header file with a object entry. This entry is used as mnemonic to determine the type of result. Result files with unsupported mnemonics are described as SYS_RES_UNKNOWN followed by the object name within square brackets.

Supported Mnemonics:

Mnemonic
Dataset
U
SYS_RES_V
p
SYS_RES_PRES
T
SYS_RES_TEMP
rho
SYS_RES_DENS

Table of Contents

5.63 Function Descriptions

The currently available OpenFOAMLib functions are described in detail in this section.


Table of Contents , OpenFOAMLib

NAME

*vdm_OpenFOAMLibBegin - create an instance of a OpenFOAMLib object

C SPECIFICATION

vdm_OpenFOAMLib *vdm_OpenFOAMLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created OpenFOAMLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a OpenFOAMLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a OpenFOAMLib object using

     void vdm_OpenFOAMLibEnd (vdm_OpenFOAMLib *openfoamlib)

Return the current value of a OpenFOAMLib object error flag using

     Vint vdm_OpenFOAMLibError (vdm_OpenFOAMLib *openfoamlib)


Table of Contents , OpenFOAMLib

NAME

vdm_OpenFOAMLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_OpenFOAMLibDataFun (vdm_OpenFOAMLib *openfoamlib,
                             vdm_DataFun *datafun);

INPUT ARGUMENTS

openfoamlib  Pointer to OpenFOAMLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , OpenFOAMLib

NAME

vdm_OpenFOAMLibAbort - set abort flag

C SPECIFICATION

void vdm_OpenFOAMLibAbort (vdm_OpenFOAMLib *openfoamlib)

INPUT ARGUMENTS

openfoamlib      Pointer to OpenFOAMLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_OpenFOAMLibSetFunction.


Table of Contents , OpenFOAMLib

NAME

vdm_OpenFOAMLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_OpenFOAMLibSetFunction (vdm_OpenFOAMLib *openfoamlib,
                                 Vint funtype,
                                 void (*function)(vdm_OpenFOAMLib*, Vobject*),
                                 Vobject *object)

INPUT ARGUMENTS

openfoamlib      Pointer to OpenFOAMLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.64 Patran Neutral model and results file - PatLib

The Patran results files format has limited support for descriptive information concerning the data a results file may contain. Therefore two additional, non standard, functions are required when reading Patran results files to indicate the result type and the columns of data which are to be associated with the components of the result data type. The methods associated with a PatLib object are the following.

Instance a PatLib object using vdm_PatLibBegin. Once instanced set pointers to abstract data functions using vdm_PatLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_PatLibSetFunction.

If a PatLib module is used to read model information from a Patran Neutral File, type SYS_PATRAN_NEUTRAL, then the non standard functions are ignored. If results files are being read, type SYS_PATRAN_RESULT, then it may be necessary to specify the result type and columns if the defaults are not sufficient. Note that Patran results files do not contain any model information and by necessity must always be appended with vdm_DataFunAppend rather than opened with vdm_DataFunOpen

The Patran neutral model and results files may be in either text or binary format. The current implementation only supports text formatted files. Supported results files include 1) displacement or force results file, 2) nodal results file, and 3) element results file. The beam results file and element coordinate file are not supported.

The PARTID.E dataset is set to the property id.

The interface currently recognizes the following Neutral System packet types.

Packet Type
Description
25
Title Card
26
Summary Data
01
Node Data
02
Element Data
03
Material Properties
04
Element Properties
05
Coordinate Frames
06
Distributed Loads
07
Node Forces
08
Node Displacements
10
Node Temperatures
14
MPC Data
15
Nodal Heat Source
16
Distributed Heat Source
17
Convection Coefficients
21
NAME'd Component Data

Table of Contents

5.65 Function Descriptions

The PatLib functions are described in detail in this section.


Table of Contents , PatLib

NAME

*vdm_PatLibBegin - create an instance of a PatLib object

C SPECIFICATION

vdm_PatLib *vdm_PatLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created PatLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a PatLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a PatLib object using

     void vdm_PatLibEnd (vdm_PatLib *patlib)

Return the current value of a PatLib object error flag using

     Vint vdm_PatLibError (vdm_PatLib *patlib)


Table of Contents , PatLib

NAME

vdm_PatLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_PatLibDataFun (vdm_PatLib *patlib,
                        vdm_DataFun *datafun);

INPUT ARGUMENTS

patlib       Pointer to PatLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , PatLib

NAME

vdm_PatLibAbort - set abort flag

C SPECIFICATION

void vdm_PatLibAbort (vdm_PatLib *patlib)

INPUT ARGUMENTS

patlib       Pointer to PatLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_PatLibSetFunction.


Table of Contents , PatLib

NAME

vdm_PatLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_PatLibSetFunction (vdm_PatLib *patlib,
                            Vint funtype,
                            void (*function)(vdm_PatLib*, Vobject*),
                            Vobject *object)

INPUT ARGUMENTS

patlib       Pointer to PatLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.


Table of Contents , PatLib

NAME

vdm_PatLibSetResultCols - set result columns

C SPECIFICATION

void vdm_PatLibSetResultCols (vdm_PatLib *patlib,
                              Vint ncols,
                              Vint icols[])

INPUT ARGUMENTS

patlib       Pointer to PatLib object.
ncols        Number of columns to select
icols        Column numbers to select

OUTPUT ARGUMENTS

None

DESCRIPTION

Set columns in Patran results file to be associated with each component of the result type. Set the result type using vdm_PatLibSetResultType. The column numbers, icols, start from 1 and may not exceed 200. A Patran results file may contain no more than 200 columns. By default ncols is 6 and icols is {1,2,3,4,5,6}.


Table of Contents , PatLib

NAME

vdm_PatLibSetResultType - set result type

C SPECIFICATION

void vdm_PatLibSetResultType (vdm_PatLib *patlib,
                              Vint rtype,
                              Vint restype,
                              Vint sect)

INPUT ARGUMENTS

patlib       Pointer to PatLib object.
rtype        Patran results file type
             =PATLIB_DISPLACEMENT      Patran displacement/force file
             =PATLIB_ELEMENTAL         Patran elemental file
             =PATLIB_NODAL             Patran nodal file
restype      Results type (see vis_RPropSetType)
sect         Section number (see vis_RPropSetSect)

OUTPUT ARGUMENTS

None

DESCRIPTION

Set results type description. See the appropriate VisTools RProp function for explanations of restype and sect. By default rtype is PATLIB_DISPLACEMENT, restype is SYS_RES_D and sect is 0.

Table of Contents

5.66 ESI/PAM-CRASH DAISY and ERF file - PAMLib

The ESI/PAM-CRASH DAISY database is a binary results database produced during an execution of PAM-CRASH from ESI-GROUP. An alternate results file, ERF, uses the HDF5 database model. The .erfh5 model consists of finite element model and results data.

The methods associated with a PAMLib object are the following.

Instance a PAMLib object using vdm_PAMLibBegin. Once instanced set pointers to abstract data functions using vdm_PAMLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_PAMLibSetFunction.

The .DSY and ERF consists of finite element model and results data. Each dataset name in the state data section is appended with the state number, state.

Each dataset in the state data section has dataset attributes which correspond to the time word and global data items associated with each state on the database. One or more of the following dataset attributes are available for each state.

DSY Supported Mnemonics, Results

Mnemonic
Dataset
N
M
FAXI
FSSH
FTSH
MTOR
MSN1
MTN1
MSN2
MTN2
SFM
DAXI
RTOR
RSN1
RTN1
RSN2
RTN2
SEK
S
S
EPLE
E.[EQUIV,PLAST]
THIC
THICKNESS
INED
SE_DENSITY
-
D
-
V
-
A

ERF Supported Mnemonics, Results (followed by qualifiers, if applicable)

Mnemonic
Dataset Qualifier 1 Qualifier 2
THICKNESS
SYS_RES_THICKNESS
RFORCE
SYS_RES_FORCE SYS_QUA_REL RESIDUAL
EPLE
SYS_RES_E SYS_QUA_EQUIV SYS_QUA_PLAST
DISPLACEMENTS_NOD
SYS_RES_D  
Velocity
SYS_RES_V  
SPRING_Local_Force
SYS_RES_FORCE SYS_QUA_LOCAL SPRING
SPRING_Local_Moment
SYS_RES_FORCE SYS_QUA_LOCAL SPRING
Upper_Surface_engineering_Strain
SYS_RES_E  
Membrane_Stress
SYS_RES_S  
Acceleration
SYS_RES_A  
Strainrate3D
SYS_RES_E_RATE  
Max_Equivalent_Stress
SYS_RES_S SYS_QUA_MAXIMUM SYS_QUA_EQUIV
Min_Equivalent_Stress
SYS_RES_S SYS_QUA_MINIMUM SYS_QUA_EQUIV
Membrane_Equivalent_Stress
SYS_RES_S SYS_QUA_EQUIV
Lower_S_Equivalent_Stress
SYS_RES_S SYS_QUA_EQUIV
Upper_S_Equivalent_Stress
SYS_RES_S SYS_QUA_EQUIV
Strain3D_Green_Lagrange
SYS_RES_E SYS_QUA_GREEN
Strain3D
SYS_RES_E  
BEAM_Force
SYS_RES_SFM  
Upper_S_Stress
SYS_RES_S  
Rotational_Angle_local
SYS_RES_D SYS_QUA_LOCAL
Rotational_Velocity_global
SYS_RES_V  
Thermal_Flux
SYS_RES_HEAT_FLUX  
Displacement_global
SYS_RES_D  
Stress3D
SYS_RES_S  
Equivalent_Stress2D
SYS_RES_S SYS_QUA_EQUIV
Equivalent_Stress3D
SYS_RES_S SYS_QUA_EQUIV
Stress2D_Corner
SYS_RES_S  
Stress3D_Corner
SYS_RES_S  
Equivalent_Stress3D_Corner
SYS_RES_S SYS_QUA_EQUIV
Equivalent_Stress2D_Corner
SYS_RES_S SYS_QUA_EQUIV
Upper_Thermal_Strain
SYS_RES_E SYS_QUA_THERMAL
Lower_Thermal_Strain
SYS_RES_E SYS_QUA_THERMAL
Moment_local
SYS_RES_SFM  
Rotational_Acceleration_local
SYS_RES_A SYS_QUA_LOCAL
Lower_Surface_Strain
SYS_RES_E  
Lower_S_Strain
SYS_RES_E  
Upper_S_Strain
SYS_RES_E  
BAR_Axial_Force
SYS_RES_SFM  
BEAM_Rotation_N1
SYS_RES_SEK  
BEAM_Rotation_N2
SYS_RES_SEK  
Rotational_Velocity_local
SYS_RES_V SYS_QUA_LOCAL
Rotational_Angle_global
SYS_RES_D  
Lower_Ply_Stress_XX
SYS_RES_S SYS_QUA_XX PLY
Lower_Ply_Stress_YY
SYS_RES_S SYS_QUA_YY PLY
Lower_Ply_Stress_XY
SYS_RES_S SYS_QUA_XY PLY
Lower_Ply_Stress_XZ
SYS_RES_S SYS_QUA_ZX PLY
Lower_Ply_Stress_YZ
SYS_RES_S SYS_QUA_YZ PLY
Upper_Ply_Stress_XX
SYS_RES_S SYS_QUA_XX PLY
Upper_Ply_Stress_YY
SYS_RES_S SYS_QUA_YY PLY
Upper_Ply_Stress_XY
SYS_RES_S SYS_QUA_XY PLY
Upper_Ply_Stress_XZ
SYS_RES_S SYS_QUA_ZX PLY
Upper_Ply_Stress_YZ
SYS_RES_S SYS_QUA_YZ PLY
Translational_Acceleration_local
SYS_RES_A SYS_QUA_LOCAL
BEAM_Moment_N1
SYS_RES_SFM  
BEAM_Moment_N2
SYS_RES_SFM  
Upper_Surface_Strain
SYS_RES_E  
BAR_Axial_Strain
SYS_RES_SEK  
Translational_Velocity_local
SYS_RES_V SYS_QUA_LOCAL
COORDINATE
SYS_RES_X  
Contact_Pressure_X
SYS_RES_TRAC SYS_QUA_CONTACT
Contact_Pressure_Y
SYS_RES_TRAC  
Contact_Pressure_Z
SYS_RES_TRAC  
Contact_Pressure_N
SYS_RES_PRES SYS_QUA_CONTACT
Contact_Force
SYS_RES_FORCE SYS_QUA_CONTACT
Membrane_Stress_Res_local
SYS_RES_SFM  
Rotational_Acceleration_global
SYS_RES_A  
BEAM_Elongation
SYS_RES_SEK  
Lower_S_Stress
SYS_RES_S  
Lower_Ply_Strain_XX
SYS_RES_E SYS_QUA_XX PLY
Lower_Ply_Strain_YY
SYS_RES_E SYS_QUA_YY PLY
Lower_Ply_Strain_XY
SYS_RES_E SYS_QUA_XY PLY
Lower_Ply_Strain_XZ
SYS_RES_E SYS_QUA_ZX PLY
Lower_Ply_Strain_YZ
SYS_RES_E SYS_QUA_YZ PLY
Upper_Ply_Strain_XX
SYS_RES_E SYS_QUA_XX PLY
Upper_Ply_Strain_YY
SYS_RES_E SYS_QUA_YY PLY
Upper_Ply_Strain_XY
SYS_RES_E SYS_QUA_XY PLY
Upper_Ply_Strain_XZ
SYS_RES_E SYS_QUA_ZX PLY
Upper_Ply_Strain_YZ
SYS_RES_E SYS_QUA_YZ PLY
Lower_Ply_Tsai_Wu_Criterion
SYS_RES_FAT_DAMAGE PLY,TSAI_WU
Upper_Ply_Tsai_Wu_Criterion
SYS_RES_FAT_DAMAGE PLY,TSAI_WU
Max_Plastic_Strain
SYS_RES_E SYS_QUA_MAXIMUM SYS_QUA_PLAST
Min_Plastic_Strain
SYS_RES_E SYS_QUA_MINIMUM SYS_QUA_PLAST
Membrane_Plastic_Strain
SYS_RES_E SYS_QUA_EQUIV SYS_QUA_PLAST
FPM_Static_Density
SYS_RES_DENS SYS_QUA_STATIC FPM
FPM_Static_Temperature
SYS_RES_TEMP SYS_QUA_STATIC FPM
FPM_Static_Pressure
SYS_RES_PRES SYS_QUA_STATIC FPM
OTMCO Reaction force
SYS_RES_R SYS_QUA_MPC
OTMCO Reaction moment
SYS_RES_R SYS_QUA_MPC
BASIS3X3
SYS_RES_ROT_ANG  
TEMP
SYS_RES_TEMP  
BEAM_Stress_P1
SYS_RES_S  
BEAM_Stress_P2
SYS_RES_S  
BEAM_Stress_P3
SYS_RES_S  
BEAM_Stress_P4
SYS_RES_S  
RFLUX
SYS_RES_R_HEAT_FLOW  
DMG
SYS_RES_FAT_DAMAGE  
DINT
SYS_RES_ENERGY_DENSITY  
DHGL
SYS_RES_ENERGY_DENSITY HOURGLASS
EINT
SYS_RES_ENERGY  
EHGL
SYS_RES_ENERGY HOURGLASS

Table of Contents

5.67 Function Descriptions

The currently available PAMLib functions are described in detail in this section.


Table of Contents , PAMLib

NAME

*vdm_PAMLibBegin - create an instance of a PAMLib object

C SPECIFICATION

vdm_PAMLib *vdm_PAMLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created PAMLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a PAMLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a PAMLib object using

     void vdm_PAMLibEnd (vdm_PAMLib *pamlib)

Return the current value of a PAMLib object error flag using

     Vint vdm_PAMLibError (vdm_PAMLib *pamlib)


Table of Contents , PAMLib

NAME

vdm_PAMLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_PAMLibDataFun (vdm_PAMLib *pamlib,
                        vdm_DataFun *datafun);

INPUT ARGUMENTS

pamlib       Pointer to PAMLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , PAMLib

NAME

vdm_PAMLibAbort - set abort flag

C SPECIFICATION

void vdm_PAMLibAbort (vdm_PAMLib *pamlib)

INPUT ARGUMENTS

pamlib      Pointer to PAMLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_PAMLibSetFunction.


Table of Contents , PAMLib

NAME

vdm_PAMLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_PAMLibSetFunction (vdm_PAMLib *pamlib,
                            Vint funtype,
                            void (*function)(vdm_PAMLib*, Vobject*),
                            Vobject *object)

INPUT ARGUMENTS

pamlib       Pointer to PAMLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.68 PERMAS result file - PERMASLib

The PERMAS POST file is the output generated by PERMAS during its execution. Each PERMAS POST file contains results and/or model definition for a single component, even if the original model contained multiple components.

The methods associated with a PERMASLib object are the following.

Instance a PERMASLib object using vdm_PERMASLibBegin. Once instanced set pointers to abstract data functions using vdm_PERMASLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_PERMASLibSetFunction.

Each component in a PERMAS file requires a different DataFun object, but DataFunAppend can be used to combine multiple results files associated with the same component.

The PARTID.E dataset is assigned the same value as the PID.E dataset. These are created in ascending order, starting from 1. A unique partid is assigned to an element based on the GEODAT and MATERIAL information. Part id values associated with $PART are ignored.

NSET and ESET commands generate node and element sets, respectively.

Supported results are as follows:

Variable
Description Dataset
ACCE
Acceleration A
ACCE
Rate of Twist Acceleration UNKNOWN.[RATE_TWIST_ACCEL]
ACCE
Inner Fluid Acceleration A.[FLUID]
ACCPOTE
Magnetic Potential Acceleration UNKNOWN.[ACC_MAGPOT]
ACCPOTE
Electric Potential Acceleration UNKNOWN.[ACC_ELECPOT]
CADEF
Definition Counter UNKNOWN.[DEF_COUNTER]
CADEF
Definition Type UNKNOWN.[DEF_TYPE]
CADEF
DOF Family Type UNKNOWN.[DOF_FAM_TYPE]
CADEF
Isolation Type UNKNOWN.[ISOLATION_TYPE]
CADEF
King Angle UNKNOWN.[KINK_ANGLE]
CADEF
Doublet Type UNKNOWN.[DOUBLET_TYPE]
CADISP
Contact Displacement DISP_CONTACT.[NORMAL]
CADISP
Contact Displacement DISP_CONTACT.[TANG]
CAFRATIO
Effective Frictional Coefficient UNKNOWN.[EFF_FRIC_COEFF]
CAFRATIO
Percent Saturation of Sticking Forces UNKNOWN.[PERCENT_SATUR_STICK_FORC]
CAFRATIO
Percent Slip Saturation Deficit UNKNOWN.[PERCENT_SLIP_SATUR_DEFICIT]
CAFRATIO
Slip Force Declination Angle UNKNOWN.[SLIP_FORC_DECL_ANGLE]
CAFWORK
Energy ENERGY.[FRICTION]
CAFWORKDENS
Energy Density ENERGY_DENSITY.[FRICTION]
CAGAPS
Gap Thickness GAP_THICKNESS
CAGAPV
Normal Gap Width GAP_THICKNESS.[NORMAL]
CAGAPV
Tangential Gap Offset GAP_THICKNESS.[TANG]
CAGEO
Nadir Vector UNKNOWN.[NADIR_VECTOR]
CAPRES
Pressure PRES.[CONTACT]
CAPRES
Frictional Shear UNKNOWN.[FRICTION_SHEAR_VECTOR]
CAPRESV
Normal Contact Pressure Vector PRES.[NORMAL,CONTACT]
CAPRESV
Frictional Shear Vector TRAC.[TANG,CONTACT]
CAREAK
Force FORCE.[NORMAL,CONTACT]
CAREAK
Force FORCE.[TANG,CONTACT]
CARESI
Normal Gap Residuum UNKNOWN.[NORMAL_GAP_RES]
CARESI
Tangential Residuum UNKNOWN.[TANG_GAP_RES]
CASTATE
Status STAT.[CONTACT]
CASYS
Normal Contact Direction DIR_COS.[NORMAL,CONTACT]
DISP
Displacement D
DISP
Twist UNKNOWN.[TWIST]
DISP
Inner Fluid Displacement D.[FLUID]
EFRATIO
Element Filling Ratio UNKNOWN.[FILL_RATIO]
EKIN
Energy KE
EKINVOL
Energy Density Per Unit Volume KE_DENSITY
EKINMASS
Energy Density Per Unit Mass UNKNOWN.[KINETIC_ENERGY_PER_MASS]
ELEMENTCOG
Element Center of Gravity X,[COG]
HEATFLUX
Heat Flux HEAT_FLUX
HEATFLUXDENS
Heat Flux Density UNKNOWN.[HEAT_FLUX_DENS]
INICAGAPS
Initial Gap Thickness GAP_THICKNESS.[INITIAL]
INICAPAPV
Initial Normal Gap Width GAP_THICKNESS.[INITIAL,NORMAL]
INICAPAPV
Initial Tangential Gap Offset GAP_THICKNESS.[INITIAL,TANG]
INICASTATE
Status STATUS.[INITIAL,CONTACT]
NPSTRAIN
Strain E
NPSTRESS
Stress S
POTE
Magnetic Potential MAG_POT
POTE
Electric Potential ELEC_POT
PRES
Pressure PRES
PRINSTRAIN
Principal Strain E.[PRINCIPAL]
PRINSTRAIN
Direction Cosine Matrix DIR_COS.[PRINCIPAL,STRAIN]
PRINSTRESS
Principal Stress S.[PRINCIPAL]
PRINSTRESS
Direction Cosine Matrix DIR_COS.[PRINCIPAL,STRESS]
REAK
Reaction Force R
REAK
Bimoment UNKNOWN.[BIMOMENT]
REAK
Inner Fluid Pressure PRES.[FLUID]
REAKD
Reaction Force on Dependent DOFS R.[DEP_DOFS]
REAKD
Bimoment on Dependent DOFS UNKNOWN.[BIMOMENT,DEP_DOFS]
REAKD
Inner Fluid Pressure on Dependent DOFS PRES.[FLUID,DEP_DOFS]
STRESSRES
Flange, Spring, or Dampener Force FORCE
STRESSRES
Stress Resultant SFM
STRESSRES
Bimoment UNKNOWN.[BIMOMENT]
STRESSRES
Pressure PRES.[INNER_FLUID]
STRESSRES
Spring or Dampener Moment MOMENT
TEMP
Temperature TEMP
TEMP
Temperature Difference TEMP.[DIFFERENCE]
VELO
Velocity V
VELO
Rate of Twist Velocity UNKNOWN.[RATE_TWIST_VEL]
VELO
Inner Fluid Velocity V.[FLUID]
VELPOTE
Magnetic Potential Velocity UNKNOWN.[VEL_MAGPOT]
VELPOTE
Electric Potential Velocity UNKNOWN.[VEL_ELECPOT]
X_ELPRINCMP
Principal Stress S.[PRINCIPAL]
X_ELSTRAIN
Strain E
X_ELSTRESS
Stress S
X_ELVE
Element Test Information UNKNOWN.[TEST_INFO]

Table of Contents

5.69 Function Descriptions

The currently available PERMASLib functions are described in detail in this section.


Table of Contents , PERMASLib

NAME

*vdm_PERMASLibBegin - create an instance of a PERMASLib object

C SPECIFICATION

vdm_PERMASLib *vdm_PERMASLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created PERMASLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a PERMASLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a PERMASLib object using

     void vdm_PERMASLibEnd (vdm_PERMASLib *permaslib)

Return the current value of a PERMASLib object error flag using

     Vint vdm_PERMASLibError (vdm_PERMASLib *permaslib)


Table of Contents , PERMASLib

NAME

vdm_PERMASLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_PERMASLibDataFun (vdm_PERMASLib *permaslib,
                           vdm_DataFun *datafun);

INPUT ARGUMENTS

permaslib    Pointer to PERMASLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , PERMASLib

NAME

vdm_PERMASLibAbort - set abort flag

C SPECIFICATION

void vdm_PERMASLibAbort (vdm_PERMASLib *permaslib)

INPUT ARGUMENTS

permaslib    Pointer to PERMASLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_PERMASLibSetFunction.


Table of Contents , PERMASLib

NAME

vdm_PERMASLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_PERMASLibSetFunction (vdm_PERMASLib *permaslib,
                               Vint funtype,
                               void (*function)(vdm_PERMASLib*, Vobject*),
                               Vobject *object)

INPUT ARGUMENTS

permaslib    Pointer to PERMASLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.70 NASA/PLOT3D grid, solution and function files - PLOT3DLib

The PLOT3D grid file format can be formatted in a number of ways. A non standard function is required to specify whether or not certain grid records are present. The PLOT3D solution and function files format has limited support for descriptive information concerning the data a file may contain. Therefore an additional, non standard, function is required when reading PLOT3D solution and/or function files to indicate the result type.

The methods associated with a PLOT3DLib object are the following.

Instance a PLOT3DLib object using vdm_PLOT3DLibBegin. Once instanced set pointers to abstract data functions using vdm_PLOT3DLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_PLOT3DLibSetFunction.

If a PLOT3DLib module is used to read model information from a PLOT3D Grid File, type SYS_PLOT3D_GRID, then it may be necessary to specify the grid type using vdm_PLOT3DLibSetGridType if the defaults are not sufficient.

If solution or function files are being read, type SYS_PLOT3D_SOLUTION, then it may be necessary to specify the solution type using vdm_PLOT3DLibSetResultType if the defaults are not sufficient. Note that PLOT3D solution and function files do not contain any model information and by necessity must always be appended with vdm_DataFunAppend rather than opened with vdm_DataFunOpen

The NASA/PLOT3D data files are associated with the NASA Ames Research Center PLOT3D visualization program. The file types include grid XYZ files, solution Q files and function files. These file formats may be formatted, unformatted or binary. Currently only "whole" 3D structured or unstructured, multiblocked, iblanked binary files are supported, "planes" or 2D files are not supported.

Table of Contents

5.71 Function Descriptions

The PLOT3DLib functions are described in detail in this section.


Table of Contents , PLOT3DLib

NAME

*vdm_PLOT3DLibBegin - create an instance of a PLOT3DLib object

C SPECIFICATION

vdm_PLOT3DLib *vdm_PLOT3DLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created PLOT3DLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a PLOT3DLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a PLOT3DLib object using

     void vdm_PLOT3DLibEnd (vdm_PLOT3DLib *plot3dlib)

Return the current value of a PLOT3DLib object error flag using

     Vint vdm_PLOT3DLibError (vdm_PLOT3DLib *plot3dlib)


Table of Contents , PLOT3DLib

NAME

vdm_PLOT3DLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_PLOT3DLibDataFun (vdm_PLOT3DLib *plot3dlib,
                           vdm_DataFun *datafun);

INPUT ARGUMENTS

plot3dlib    Pointer to PLOT3DLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , PLOT3DLib

NAME

vdm_PLOT3DLibAbort - set abort flag

C SPECIFICATION

void vdm_PLOT3DLibAbort (vdm_PLOT3DLib *plot3dlib)

INPUT ARGUMENTS

plot3dlib      Pointer to PLOT3DLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_PLOT3DLibSetFunction.


Table of Contents , PLOT3DLib

NAME

vdm_PLOT3DLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_PLOT3DLibSetFunction (vdm_PLOT3DLib *plot3dlib,
                               Vint funtype,
                               void (*function)(vdm_PLOT3DLib*, Vobject*),
                             Vobject *object)

INPUT ARGUMENTS

plot3dlib    Pointer to PLOT3DLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.


Table of Contents , PLOT3DLib

NAME

vdm_PLOT3DLibSetGridType - set grid type

C SPECIFICATION

void vdm_PLOT3DLibSetGridType (vdm_PLOT3DLib *plot3dlib,
                              Vint gtype,
                              Vint dime,
                              Vint iblank)

INPUT ARGUMENTS

plot3dlib    Pointer to PLOT3DLib object.
gtype        Grid type
             =PLOT3DLIB_AUTO           Auto detect
             =PLOT3DLIB_SINGLE         Single block grid
             =PLOT3DLIB_MULTIPLE       Multiblock grid
dime         Dimension and layout
             =PLOT3DLIB_AUTO           Auto detect
             =PLOT3DLIB_2D             2D structured
             =PLOT3DLIB_3DWHOLE        3D structured WHOLE
             =PLOT3DLIB_3DPLANES       3D structured PLANES
             =PLOT3DLIB_UNSTRUCTURED   3D unstructured
iblank       IBlanking flag

OUTPUT ARGUMENTS

None

DESCRIPTION

Define grid type of Grid file. By default gtype is PLOT3DLIB_AUTO, dime is PLOT3DLIB_AUTO, and iblank is off.


Table of Contents , PLOT3DLib

NAME

vdm_PLOT3DLibSetResultType - set solution result type

C SPECIFICATION

void vdm_PLOT3DLibSetResultType (vdm_PLOT3DLib *plot3dlib,
                                 Vint rtype,
                                 Vint restype)

INPUT ARGUMENTS

plot3dlib    Pointer to PLOT3DLib object.
rtype        Patran results file type
             =PLOT3DLIB_Q              PLOT3D solution file
             =PLOT3DLIB_FUNCTION       PLOT3D function file
restype      Results type (see vis_RPropSetType)

OUTPUT ARGUMENTS

None

DESCRIPTION

Set results type description. See the appropriate VisTools RProp function for explanations of restype. By default rtype is PLOT3DLIB_Q and restype is SYS_RES_V.

Table of Contents

5.72 POLYFLOW data base - POLYFLOWLib

The POLYFLOW data base consists of a mesh file and a list of results files. The mesh file is normally contained in a file with extension .msh, while the results can be found in files whose names contain either the extension .res or its base name contains the substring res. The POLYFLOW data base is supported for reading only. The .msh file is the key file, the POLYFLOW reader will find related results files.

The methods associated with a POLYFLOWLib object are the following.

Instance a POLYFLOWLib object using vdm_POLYFLOWLibBegin. Once instanced set pointers to abstract data functions using vdm_POLYFLOWLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_POLYFLOWLibSetFunction.

The POLYFLOW reader supports all of POLYFLOW element types, namely linear two and three-dimensional elements. The PARTID.E dataset is set to the subdomain id.

Table of Contents

5.73 Function Descriptions

The currently available POLYFLOWLib functions are described in detail in this section.


Table of Contents , POLYFLOWLib

NAME

*vdm_POLYFLOWLibBegin - create an instance of a POLYFLOWLib object

C SPECIFICATION

vdm_POLYFLOWLib *vdm_POLYFLOWLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created POLYFLOWLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a POLYFLOWLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a POLYFLOWLib object using

     void vdm_POLYFLOWLibEnd (vdm_POLYFLOWLib *polyflowlib)

Return the current value of a POLYFLOWLib object error flag using

     Vint vdm_POLYFLOWLibError (vdm_POLYFLOWLib *polyflowlib)


Table of Contents , POLYFLOWLib

NAME

vdm_POLYFLOWLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_POLYFLOWLibDataFun (vdm_POLYFLOWLib *polyflowlib,
                             vdm_DataFun *datafun);

INPUT ARGUMENTS

polyflowlib  Pointer to POLYFLOWLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , POLYFLOWLib

NAME

vdm_POLYFLOWLibAbort - set abort flag

C SPECIFICATION

void vdm_POLYFLOWLibAbort (vdm_POLYFLOWLib *polyflowlib)

INPUT ARGUMENTS

polyflowlib      Pointer to POLYFLOWLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_POLYFLOWLibSetFunction.


Table of Contents , POLYFLOWLib

NAME

vdm_POLYFLOWLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_POLYFLOWLibSetFunction (vdm_POLYFLOWLib *polyflowlib,
                                 Vint funtype,
                                 void (*function)(vdm_POLYFLOWLib*, Vobject*),
                                 Vobject *object)

INPUT ARGUMENTS

polyflowlib  Pointer to POLYFLOWLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Each results dataset name is appended with the flow solution index number, id1. If a single results file is found, then id1 is 1. Otherwise, id1 is extracted from the file name. If more than one result of the same type is found in the file it is distinguished from others with a second identification, id2.

This interface supports the import of unknown variables. Any specific POLYFLOW field name (data name identifier for flow solution quantity) which does not match the current list of VdmTools specific variable names will be imported as SYS_RES_UNKNOWN. The dataset name will include the POLYFLOW field name immediately after the dataset root name (UNKNOWN). See section VdmTools, Finite Element Result Dataset Names and Descriptions for a description of VdmTools specific variable names. The variable names are the "Contents" string.

Supported Variable Names, Results

POLYFLOW Field Name
Dataset
TEMPERATURE
TEMP
PRESSURE
PRES
STREAM FUNCTION
STREAM
VELOCITIES
V
COORDINATES
D

The convention, VDM_CONVENTION_DOUBLE, can be used to export floating point data in single or double precision. The default export precision is single. All nodes and elements are exported as a single unstructured zone.

Element edge and face sets, in two or three-dimensional problems, respectively, are created for the free boundaries. Each set is assigned an identification number corresponding to the boundary id as specified in the mesh file.

Scalar, vector and symmetric tensor data types are exported, all others are ignored. Results can be either nodal, centroidal, or element nodal.

Table of Contents

5.74 Writing PTC/Mechanica FEM Neutral Format - RASFil

The PTC/Mechanica FEM Neutral File is used to exchange data between Mechanica and finite element programs. FEM Neutral Format files have the file extension .fnf and are ASCII files consisting of lines 80 characters or less. The RASFil module supports the writing of nodes, elements, coordinate systems and applied loads and restraints. The LMan module function vdm_LManSaveModel is used to perform the actual file writing.

The methods associated with a RASFil object are the following.

Instance a RASFil object using vdm_RASFilBegin. Once instanced set pointers to abstract data functions using vdm_RASFilDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_RASFilSetFunction.

Table of Contents

5.75 Function Descriptions

The currently available RASFil functions are described in detail in this section.


Table of Contents , RASFil

NAME

*vdm_RASFilBegin - create an instance of a RASFil object

C SPECIFICATION

vdm_RASFil *vdm_RASFilBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created RASFil object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a RASFil object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a RASFil object using

     void vdm_RASFilEnd (vdm_RASFil *rasfil)

Return the current value of a RASFil object error flag using

     Vint vdm_RASFilError (vdm_RASFil *rasfil)


Table of Contents , RASFil

NAME

vdm_RASFilDataFun - fill DataFun object

C SPECIFICATION

void vdm_RASFilDataFun (vdm_RASFil *rasfil,
                        vdm_DataFun *datafun);

INPUT ARGUMENTS

rasfil       Pointer to RASFil object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , RASFil

NAME

vdm_RASFilAbort - set abort flag

C SPECIFICATION

void vdm_RASFilAbort (vdm_RASFil *rasfil)

INPUT ARGUMENTS

rasfil       Pointer to RASFil object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_RASFilSetFunction.


Table of Contents , RASFil

NAME

vdm_RASFilSetFunction - set a call back functions

C SPECIFICATION

void vdm_RASFilSetFunction (vdm_RASFil *rasfil,
                            Vint funtype,
                            void (*function)(vdm_RASFil*, Vobject*),
                            Vobject *object)

INPUT ARGUMENTS

rasfil       Pointer to RASFil object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.76 PTC/Mechanica Design Study - RASLib

The PTC/Mechanica design study is a directory consisting of subdirectories and files containing analysis model and results data. The directory is called study where study is the name of the design study and subdirectories called anlys1, anlys2, ... where anlys1, anlys2, ... are the names of the analyses. Only the binary form of the results data files is supported.

The methods associated with a RASLib object are the following.

Instance a RASLib object using vdm_RASLibBegin. Once instanced set pointers to abstract data functions using vdm_RASLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_RASLibSetFunction.

The key file in a Mechanica Design Study must be the .neu file located in an analysis subdirectory. The path to key file must include the names of the study and analysis directories. The following file types are read.

The load set or mode number, set, is appended to each results dataset in the analysis. A frequency attribute is added to modal result datasets. Table of Contents

5.77 Function Descriptions

The currently available RASLib functions are described in detail in this section.


Table of Contents , RASLib

NAME

*vdm_RASLibBegin - create an instance of a RASLib object

C SPECIFICATION

vdm_RASLib *vdm_RASLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created RASLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a RASLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a RASLib object using

     void vdm_RASLibEnd (vdm_RASLib *raslib)

Return the current value of a RASLib object error flag using

     Vint vdm_RASLibError (vdm_RASLib *raslib)


Table of Contents , RASLib

NAME

vdm_RASLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_RASLibDataFun (vdm_RASLib *raslib,
                        vdm_DataFun *datafun);

INPUT ARGUMENTS

raslib       Pointer to RASLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , RASLib

NAME

vdm_RASLibAbort - set abort flag

C SPECIFICATION

void vdm_RASLibAbort (vdm_RASLib *raslib)

INPUT ARGUMENTS

raslib       Pointer to RASLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_RASLibSetFunction.


Table of Contents , RASLib

NAME

vdm_RASLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_RASLibSetFunction (vdm_RASLib *raslib,
                            Vint funtype,
                            void (*function)(vdm_RASLib*, Vobject*),
                            Vobject *object)

INPUT ARGUMENTS

raslib       Pointer to RASLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.78 SAMCEF des file - SAMCEFLib

The SAMCEF des file contains mesh and results information.

The methods associated with a SAMCEFLib object are the following.

Instance a SAMCEFLib object using vdm_SAMCEFLibBegin. Once instanced set pointers to abstract data functions using vdm_SAMCEFLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_SAMCEFLibSetFunction.

Each results dataset name obtained from a SAMCEF file is appended with the load case or time step number, id1. If these are not defined, then id1 is 1. If vibration, buckling, or rigid modes are found these are assigned to id2.

This interface supports the import of unknown variables. This allows all results to be imported. The dataset name will include the SAMCEF field name immediately after the dataset root name (UNKNOWN). See section VdmTools, Finite Element Result Dataset Names and Descriptions for a description of VdmTools specific variable names. The variable names are the "Contents" string.

Supported Variable Names, Results

SAMCEF Field Name
Dataset
Pressure
PRES
Nodal temperature [lower surface]
TEMP.[LOWERSURF]
Temperature variation rate
TEMP_DOT
Nodal pressure
PRES
Nodal density
DENS
Electric potential
ELEC_POT
X-Y-Z coordinates
X
DX-DY-DZ reference displacements (in structural axes)
D
DX-DY-DZ displacements (in structural axes)
D
VX-VY-VZ velocities (in structural axes)
V
AX-AY-AZ accelerations (in structural axes)
A
RX-RY-RZ rotations
D
Reaction/residue (in structural axes)
R
Reaction/residue (in structural axes) - Force
R
Reaction/residue (in structural axes) - Torque
R
Reaction/residue (in structural axes) - Flux
HEAT_FLUX
Normal stress at point 1
S
Normal stress at point 2
S
Normal stress at point 3
S
Normal stress at point 4
S
Nodal temperature [upper surface]
TEMP.[UPPERSURF]
Nodal temperature of intermediate surfaces.
TEMP.[MIDSURF]
Rotational velocity
V
Rotational acceleration
A
Shear forces
SFM
Efforts (N,T1,T2,M,F1,F2)
SFM
Efforts (N,T1,T2)
SFM
Moment (M,F1,F2)
SFM
Normal Force
SFM
Moment
SFM
Grid Point Relative Displacement
D.[REL]
Grid Point Relative Rotation
D.[REL]
Grid Point Reaction/Force
R.[GPF]
Grid Point Reaction/Moment
R.[GPF]
Total strain
E
Normal stress at 6 points
S.[NORMAL]
Norm of shear stress at 6 points
S.[SHEAR]
Stress tensor
S
Stress tensor (codes 470-472)
S.[NONLIN]
von Mises stress
S.[VONMISES]
Kirchoff-Treffz stress tensor (PK2)
S.[PK]
Green-Lagrange total strain tensor
E.[GREEN]
Cauchy stress tensor
S.[CAUCHY]
Natural total strain tensor
E.[NATURAL]
Biot stress tensor
S.[BIOT]
Biot total strain tensor
E.[BIOT]
Mechanical strain tensor
E.[MECH]
Equivalent mechanical strain
E.[EQUIV,MECH]
Temperature
TEMP
Hydrostatic pressure
PRES.[HYDROSTATIC]
Equivalent cumulative plastic strain
E.[EQUIV,PLAST]
Plastic strain tensor
E.[PLAST]
Equivalent stress (chosen criterion)
S.[EQUIV]
Porosity
POROSITY
Potential energy
SE_DENSITY
Kinetic energy density
KE_DENSITY
Element density
DENS
Dissipated energy per unit volume
ENERGY_DENSITY.[DISSIPATED]
Dissipated power per unit volume
POWER_DENSITY.[DISSIPATED]
Degree of conversion
FRACTION
Glass transition temperature
TEMP.[GLASSTRANS]
Scalar damage
DAMAGE.[EQUIV]
Tensorial damage
DAMAGE
Conductive flux
HEAT_FLUX
Gas mass flux
MASS_FLUX.[GAS]
Current density
J_DENSITY
Transport flux
HEAT_FLUX.[CONVECTIVE]
Elemental (specific) capacitive energy
ENERGY.[SPECIFIC,CAPACITIVE]
Nodal density (PYROL DECOUPLE)
DENS
Applied surface flux
HEAT_FLUX.[APPLIED]
Convective flux (classical)
HEAT_FLUX.[CONVECTIVE]
Enthalpic flux
HEAT_FLUX.[ENTHALPY]
Resultant radiative flux
HEAT_FLUX.[RADIATIVE]
Absorbed radiative flux
HEAT_FLUX.[ABSORBED,RADIATIVE]
Emitted radiative flux
HEAT_FLUX.[RADIATIVE,EMITTED]
Resultant flame radiation flux
HEAT_FLUX.[RADIATIVE,FLAME]
Absorbed flame radiation flux
HEAT_FLUX.[ABSORBED,FLAME,RADIATIVE]
Emitted flame radiation flux
HEAT_FLUX.[EMITTED,FLAME,RADIATIVE]
Total applied flux
HEAT_FLUX.[TOT,APPLIED]
Total volume flux
HEAT_FLUX.[TOT]
Strain energy density
SE_DENSITY
Kinetic energy density
KE_DENSITY
Von Mises equivalent stress
S.[VONMISES]

The convention, VDM_CONVENTION_DOUBLE, can be used to export floating point data in single or double precision. The default export precision is single. All nodes and elements are exported as a single unstructured zone.

Scalar, vector and symmetric tensor data types are exported, all others are ignored. Results can be either nodal, centroidal, or element nodal.

Table of Contents

5.79 Function Descriptions

The currently available SAMCEFLib functions are described in detail in this section.


Table of Contents , SAMCEFLib

NAME

*vdm_SAMCEFLibBegin - create an instance of a SAMCEFLib object

C SPECIFICATION

vdm_SAMCEFLib *vdm_SAMCEFLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created SAMCEFLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a SAMCEFLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a SAMCEFLib object using

     void vdm_SAMCEFLibEnd (vdm_SAMCEFLib *samceflib)

Return the current value of a SAMCEFLib object error flag using

     Vint vdm_SAMCEFLibError (vdm_SAMCEFLib *samceflib)


Table of Contents , SAMCEFLib

NAME

vdm_SAMCEFLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_SAMCEFLibDataFun (vdm_SAMCEFLib *samceflib,
                           vdm_DataFun *datafun);

INPUT ARGUMENTS

samceflib    Pointer to SAMCEFLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , SAMCEFLib

NAME

vdm_SAMCEFLibAbort - set abort flag

C SPECIFICATION

void vdm_SAMCEFLibAbort (vdm_SAMCEFLib *samceflib)

INPUT ARGUMENTS

samceflib    Pointer to SAMCEFLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_SAMCEFLibSetFunction.


Table of Contents , SAMCEFLib

NAME

vdm_SAMCEFLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_SAMCEFLibSetFunction (vdm_SAMCEFLib *samceflib,
                               Vint funtype,
                               void (*function)(vdm_SAMCEFLib*, Vobject*),
                               Vobject *object)

INPUT ARGUMENTS

samceflib    Pointer to SAMCEFLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.80 STAR-CCM data base - STARCCMLib

The STAR-CCM file format is generated by the STAR CCM+ analysis program from CD-adapco. Files usually contain an extension .ccm and frequently contain polyhedra-based topologies. This format requires a freely available library that can be obtained by contacting CD-adapco directly.

The methods associated with a STARCCMLib object are the following.

Instance a STARCCMLib object using vdm_STARCCMLibBegin. Once instanced set pointers to abstract data functions using vdm_STARCCMLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_STARCCMLibSetFunction.

The PARTID.E dataset is set to the cell type which is read directly from the database. The cell type is described as an integer that can be used to group cells together to form subdomains and domains.

The file format segregates internal and boundary surfaces. While internal surfaces are only used to construct faces of elements, boundary surfaces are also stored as elements with VIS_FEATYPE of SYS_ELEM_INTERFACE. In addition, interface elements have an added attribute, VIS_FEASPEC, whose value is only set if it originates from boundary types given by the table below.

This interface supports the import of unknown variables. Any specific STAR-CCM variable name (data name identifier for flow solution quantity) which does not match the current list of VdmTools specific variable names will be imported as SYS_RES_UNKNOWN. The dataset name will include the STAR-CCM variable name immediately after the dataset root name (UNKNOWN). See section VdmTools, Finite Element Result Dataset Names and Descriptions for a description of VdmTools specific variable names. The variable names are the "Contents" string.

Results datasets are grouped according to their STAR-CCM State and Phase. The identification value for the State translates into a dataset's id1, while the Phase's translates into id2.

Supported Variable Names, Results

STAR-CCM Variable Name
Dataset
Pressure
PRES
ABSOLUTEPRESSURE
PRES.[ABS]
ABSOLUTETOTALPRESSURE
PRES.[TOT,ABS]
TOTALPRESSURE
PRES.[TOT]
THERMO. PRESSURE
PRES.[THERMAL]
PRESSURECOEFFICIENT
PRES_COEF
TOTALPRESSURECOEFFICIENT
PRES_COEF.[TOT]
Velocity
V
VELOCITYMAGNITUDE
V.[MAG]
CELLRELATIVEVELOCITY
V.[REL,Cell]
CELLRELATIVEVELOCITYMAGNITUDE
V.[REL,MAG,Cell]
RADIALVELOCITY
V.[RADIAL]
TANGENTIALVELOCITY
V.[TANG]
AXIALVELOCITY
V.[AXIAL]
TRANSLATIONVELOCITY
V.[Translation]
RELATIVEVELOCITY
V.[REL]
SOUNDSPEED
V.[SOUND]
Mass Flux
MASS_FLUX
MASSFLUX
MASS_FLUX
Displacement
D
Density
DENS
Temperature
TEMP
TOTALTEMPERATURE
TEMP.[TOT]
Turbulent Dissipation
TURB_ED
Turbulence - ke
TURB_KE
Turbulent Kinetic Energy
TURB_KE
Turbulent Dissipation Rate
TURB_SD
WALLDISTANCE
TURB_DIST
Particle Re Number
REYNOLDS
Molecular Viscosity
VISC
EFFECTIVEVISCOSITY
VISC.[EFF]
DYNAMICVISCOSITY
VISC.[DYNAMIC]
Turbulent Viscosity
VISC_EDDY
Turbulent - Epsilon
TURB_ED
Stress
S
Volume Fraction
VOF
Y Plus
YPLUS
SPECIFICHEAT
CP
ENTROPY
ENTROPY
ENTHALPY
H
TOTALENTHALPY
H.[TOT]
STATICENTHALPY
H.[STATIC]
AREA
AREA
AREAMAGNITUDE
AREA.[MAG]
THERMALCONDUCTIVITY
COND
EFFECTIVECONDUCTIVITY
COND.[EFF]
WALLSHEARSTRESS
WALL_SHEAR
MACHNUMBER
MACH
HEAT FLUX
HEAT_FLUX
BOUNDARYHEATFLUX
HEAT_FLUX.[Boundary]
VOLUME
VOLUME
VOLUMECHANGE
VOLUME.[Change]

Supported Boundary Types, VIS_FEASPEC

Boundary Type
VIS_FEASPEC
Wall
SYS_INTER_WALL
Outlet
SYS_INTER_OUTLET
Symmetry
SYS_INTER_SYMMETRY
Inlet
SYS_INTER_INLET
Cyclic
SYS_INTER_PERIODIC
Stagnation
SYS_INTER_STAGNATION
Pressure
SYS_INTER_PRESSURE
Baffle
SYS_INTER_BAFFLE
Freestream
SYS_INTER_FREESTREAM

Scalar, vector and non-symmetric tensor data types are exported, all others are ignored. All face-based results are converted to a nodal results by averaging values from neighboring faces.

Table of Contents

5.81 Function Descriptions

The currently available STARCCMLib functions are described in detail in this section.


Table of Contents , STARCCMLib

NAME

*vdm_STARCCMLibBegin - create an instance of a STARCCMLib object

C SPECIFICATION

vdm_STARCCMLib *vdm_STARCCMLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created STARCCMLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a STARCCMLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a STARCCMLib object using

     void vdm_STARCCMLibEnd (vdm_STARCCMLib *starccmlib)

Return the current value of a STARCCMLib object error flag using

     Vint vdm_STARCCMLibError (vdm_STARCCMLib *starccmlib)


Table of Contents , STARCCMLib

NAME

vdm_STARCCMLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_STARCCMLibDataFun (vdm_STARCCMLib *starccmlib,
                            vdm_DataFun *datafun);

INPUT ARGUMENTS

starccmlib   Pointer to STARCCMLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , STARCCMLib

NAME

vdm_STARCCMLibAbort - set abort flag

C SPECIFICATION

void vdm_STARCCMLibAbort (vdm_STARCCMLib *starccmlib)

INPUT ARGUMENTS

starccmlib   Pointer to STARCCMLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_STARCCMLibSetFunction.


Table of Contents , STARCCMLib

NAME

vdm_STARCCMLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_STARCCMLibSetFunction (vdm_STARCCMLib *starccmlib,
                                Vint funtype,
                                void (*function)(vdm_STARCCMLib*, Vobject*),
                                Vobject *object)

INPUT ARGUMENTS

starccmlib   Pointer to STARCCMLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.82 3D Systems/STL ASCII text and binary file - STLFil

The stereolithography (or STL) format is an ASCII text or binary file developed by 3D Systems Corp. It is a list of triangular facets which describe a solid model.

The methods associated with a STLFil object are the following.

Instance a STLFil object using vdm_STLFilBegin. Once instanced set pointers to abstract data functions using vdm_STLFilDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_STLFilSetFunction.

All triangle geometry in a STL file is constrained by the vertex to vertex rule - all adjacent triangles share two vertices which must be co-located. These coincident vertices are detected and assigned a single node number. Each triangular facet is assigned an element number. If the user specifies that the STL file is in ASCII format, the interface will check for an ASCII formatted file first and if this fails a binary formatted file is assumed. An element set is generated for each solid. Vertices are colocated only with individual solids. If no solids are specified in the file, then all vertices are checked for colocation. The PARTID.E dataset contains the solid number starting from 1.

Table of Contents

5.83 Function Descriptions

The currently available STLFil functions are described in detail in this section.


Table of Contents , STLFil

NAME

*vdm_STLFilBegin - create an instance of a STLFil object

C SPECIFICATION

vdm_STLFil *vdm_STLFilBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created STLFil object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a STLFil object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a STLFil object using

     void vdm_STLFilEnd (vdm_STLFil *stlfil)

Return the current value of a STLFil object error flag using

     Vint vdm_STLFilError (vdm_STLFil *stlfil)


Table of Contents , STLFil

NAME

vdm_STLFilDataFun - fill DataFun object

C SPECIFICATION

void vdm_STLFilDataFun (vdm_STLFil *stlfil,
                        vdm_DataFun *datafun);

INPUT ARGUMENTS

stlfil       Pointer to STLFil object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , STLFil

NAME

vdm_STLFilAbort - set abort flag

C SPECIFICATION

void vdm_STLFilAbort (vdm_STLFil *stlfil)

INPUT ARGUMENTS

stlfil       Pointer to STLFil object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_STLFilSetFunction.


Table of Contents , STLFil

NAME

vdm_STLFilSetFunction - set a call back functions

C SPECIFICATION

void vdm_STLFilSetFunction (vdm_STLFil *stlfil,
                            Vint funtype,
                            void (*function)(vdm_STLFil*, Vobject*),
                             Vobject *object)

INPUT ARGUMENTS

stlfil       Pointer to STLFil object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.

Table of Contents

5.84 Tecplot file format - TecplotLib

The Tecplot file format is associated with the Tecplot visualization software from Tecplot Inc. The file format is supported for both reading and writing. Only the binary file format is supported. The Tecplot file usually contains a ".plt" suffix.

The methods associated with a TecplotLib object are the following.

Instance a TecplotLib object using vdm_TecplotLibBegin. Once instanced set pointers to abstract data functions using vdm_TecplotLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_TecplotLibSetFunction.

The Tecplot reader supports both ordered and finite element zones. The node coordinate locations are assumed to have certain variable names. For example, the x coordinate is named X, x, X1, CoordinateX, X COORD, X(, X ( or XXX. Similar strings are used for the y and z coordinates. The user may specify variable name strings to be used for coordinate identification using the function vdm_TecplotLibSetCoordsNames. The elements and nodes are assumed to be those contained in the zones with no shared connectivity lists. The PARTID.E dataset contains the zone number associated with each element. By default partid is assigned to each unique zone name. Use the VDM_CONVENTION_ALTPART to enable the assignment of a partid for each zone regardless of zone name.

Use the convention, VDM_CONVENTION_CONVERTPOLY to test polygon and polyhedron cells for conversion to a primitive shape. By default polygon and polyhedron are not tested.

A step identifier will be attached to all zones with shared connectivity lists. The interface assumes that each zone with no shared connectivity list will be referenced an equal number of times by zones with shared connectivity lists. If this condition is not met then a reader error will occur and reading will terminate. If there are no zones with shared connectivity lists, no step identifiers will be assigned. If there are zones with shared connectivity lists, the number of step identifiers will be one plus the number of times a zone is referenced by another zone as a shared connectivity list.

Any variable name which does not match the current list of Tecplot or VdmTools specific variable names will be imported as an unknown, SYS_RES_UNKNOWN, variable. The dataset name for the unknown variable will include the variable name, with underscores, "_", substituted for blanks, immediately after the dataset root name (UNKNOWN). See section VdmTools, Finite Element Result Dataset Names and Descriptions for a description of VdmTools specific variable names. The variable names are the "Contents" string.

Supported Variable Names, Results

Tecplot Variable Name
Dataset
body-force 0-1,2,3
BODY_FORCE
E
ENERGY
Mach
MACH
Mach_Number
MACH
P
PRES
RHO-U,V,W
P
RHO
DENS
T
TEMP
Total_Temperature
TEMP.[TOT]
Turbulent Viscosity
VISC_EDDY
U,V,W
V
VelocityX,Y,Z
V
Wall shear-1,2,3
WALL_SHEAR

The Tecplot writer only supports binary Tecplot 11 format. The writer exports all nodes and elements as finite element zones. All higher order elements are converted to linear elements for output. A Tecplot zone must contain elements of similar topology. Therefore a zone is created for each group of topologically similar elements for each unique set of dataset identifiers. A zone will contain the values of all variables for the elements in the zone at the unique set of dataset identifiers.

Scalar, vector, symmetric tensor and element resultants results are exported. All element node results are converted to an element result for output. The Tecplot variable name is constructed from the RProp object result and qualifier types, the section number and data type component. Specifically, the undeformed node coordinates are written as variable names CoordinateX, CoordinateY and CoordinateZ.

Table of Contents

5.85 Function Descriptions

The currently available Tecplotlib functions are described in detail in this section.


Table of Contents , TecplotLib

NAME

*vdm_TecplotLibBegin - create an instance of a TecplotLib object

C SPECIFICATION

vdm_TecplotLib *vdm_TecplotLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created TecplotLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a TecplotLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a TecplotLib object using

     void vdm_TecplotLibEnd (vdm_TecplotLib *tecplotlib)

Return the current value of a TecplotLib object error flag using

     Vint vdm_TecplotLibError (vdm_TecplotLib *tecplotlib)


Table of Contents , TecplotLib

NAME

vdm_TecplotLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_TecplotLibDataFun (vdm_TecplotLib *tecplotlib,
                         vdm_DataFun *datafun);

INPUT ARGUMENTS

tecplotlib   Pointer to TecplotLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , TecplotLib

NAME

vdm_TecplotLibAbort - set abort flag

C SPECIFICATION

void vdm_TecplotLibAbort (vdm_TecplotLib *tecplotlib)

INPUT ARGUMENTS

tecplotlib   Pointer to TecplotLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_TecplotLibSetFunction.


Table of Contents , TecplotLib

NAME

vdm_TecplotLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_TecplotLibSetFunction (vdm_TecplotLib *tecplotlib,
                             Vint funtype,
                             void (*function)(vdm_TecplotLib*, Vobject*),
                             Vobject *object)

INPUT ARGUMENTS

tecplotlib      Pointer to TecplotLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.


Table of Contents , TecplotLib

NAME

vdm_TecplotLibSetCoordsNames - set user specified coordinate variable names

C SPECIFICATION

void vdm_TecplotLibSetCoordsNames (vdm_TecplotLib *tecplolib,
                                   Vchar *xname,
                                   Vchar *yname,
                                   Vchar *zname)

INPUT ARGUMENTS

tecplotlib   Pointer to TecplotLib object.
xname        Variable name of x coordinate
yname        Variable name of y coordinate
zname        Variable name of z coordinate

OUTPUT ARGUMENTS

None

DESCRIPTION

Set variable names for x, y and z coordinates. If a character string argument is NULL or if it is a zero length string, the variable name is not set.

Table of Contents

5.86 Vtk Legacy File Format - VTKLib

The Visualization ToolKit legacy file is an ASCII file containing model and results data.

The methods associated with a VTKLib object are the following.

Instance a VTKLib object using vdm_VTKLibBegin. Once instanced set pointers to abstract data functions using vdm_VTKLibDataFun. If a callback function, such as a monitor function is to be used, register this function using vdm_VTKLibSetFunction.

Only vtk files with the same step id are combined into a single model; otherwise, each step id refers to a new adapted mesh.

The PARTID.E dataset is set to a unique integer for each .vtk file.

Table of Contents

5.87 Function Descriptions

The currently available VTKlib functions are described in detail in this section.


Table of Contents , VTKLib

NAME

*vdm_VTKLibBegin - create an instance of a VTKLib object

C SPECIFICATION

vdm_VTKLib *vdm_VTKLibBegin ()

ARGUMENTS

None

FUNCTION RETURN VALUE

The function returns a pointer to the newly created VTKLib object. If the object creation fails, NULL is returned.

DESCRIPTION

Create an instance of a VTKLib object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a VTKLib object using

     void vdm_VTKLibEnd (vdm_VTKLib *vtklib)

Return the current value of a VTKLib object error flag using

     Vint vdm_VTKLibError (vdm_VTKLib *vtklib)


Table of Contents , VTKLib

NAME

vdm_VTKLibDataFun - fill DataFun object

C SPECIFICATION

void vdm_VTKLibDataFun (vdm_VTKLib *vtklib,
                         vdm_DataFun *datafun);

INPUT ARGUMENTS

vtklib       Pointer to VTKLib object.
datafun      Pointer to DataFun object to be filled with data functions.

OUTPUT ARGUMENTS

None

DESCRIPTION

Fill a DataFun object with interface data functions.


Table of Contents , VTKLib

NAME

vdm_VTKLibAbort - set abort flag

C SPECIFICATION

void vdm_VTKLibAbort (vdm_VTKLib *vtklib)

INPUT ARGUMENTS

vtklib       Pointer to VTKLib object.

OUTPUT ARGUMENTS

None

DESCRIPTION

Set abort flag. During the interface open process this flag is intermittently checked. If it has been set, the open process terminates and returns. The abort flag is usually set in the user defined callback function specified by vdm_VTKLibSetFunction.


Table of Contents , VTKLib

NAME

vdm_VTKLibSetFunction - set a call back functions

C SPECIFICATION

void vdm_VTKLibSetFunction (vdm_VTKLib *vtklib,
                            Vint funtype,
                            void (*function)(vdm_VTKLib*, Vobject*),
                            Vobject *object)

INPUT ARGUMENTS

vtklib       Pointer to VTKLib object.
funtype      Type of callback function to set
             =SYS_FUNCTION_MONITOR     Monitor callback
function     Pointer to callback function
object       Pointer to the object to be returned as function argument

OUTPUT ARGUMENTS

None

DESCRIPTION

Set callback functions. By default all callbacks are NULL. A callback is not invoked if it is NULL.


Table of Contents , VTKLib

NAME

vdm_VTKLibSetSearch - set user specified search types

C SPECIFICATION

void vdm_VTKLibSetSearch (vdm_VTKLib *vtklib,
                          Vint search)

INPUT ARGUMENTS

vtklib       Pointer to VTKLib object.
search       Search type
             =VTKLIB_SEARCH_OFF        Single file
             =VTKLIB_SEARCH_MULTIDIR   File is directory
             =VTKLIB_SEARCH_OPENFOAM   File is OpenFOAM style directory

OUTPUT ARGUMENTS

None

DESCRIPTION

Set search type. if search is VTKLIB_SEARCH_OFF (the default) then a single file is read.

If VTKLIB_SEARCH_MULTIDIR is specified, then the file being opened refers to a directory and all files with extension .vtk in this directory and any subdirectory will be read. It is assumed that file names terminate with an integer that specify a time step id.

A search type of VTKLIB_SEARCH_OPENFOAM refers to a particular file structure of VTK files generated by OpenFOAM. As with VTKLIB_SEARCH_MULTIDIR, the file being opened is a directory and all files with extension .vtk in this directory and any subdirectory will be read.