Database class

The Database class gives you access to database cards in PRIMER. More...

The PRIMER JavaScript API provides many class constants, properties and methods. For Arup to be able to extend and enhance the API in the future any constant, property or method names beginning with a lowercase or uppercase letter are reserved.
If you need to add your own properties or methods to one of the existing classes then to avoid any potential future conflict you should ensure that the name begins with either an underscore (_) or a dollar sign ($) or the name is prefixed with your own unique identifier.
For example if company 'ABC' need to add a property called 'example' then to avoid any potential future conflict use one of:

Database properties

Name Type Description
abstat Object *DATABASE_ABSTAT card
atdout Object *DATABASE_ATDOUT card
bearing Object *DATABASE_BEARING card
binary Object *DATABASE_BINARY card
bndout Object *DATABASE_BNDOUT card
dcfail Object *DATABASE_DCFAIL card
defgeo Object *DATABASE_DEFGEO card
deforc Object *DATABASE_DEFORC card
destat Object *DATABASE_DESTAT card
elout Object *DATABASE_ELOUT card
envelope Object *DATABASE_ENVELOPE card
extent_binary Object *DATABASE_EXTENT_BINARY card
extent_binary_comp Object *DATABASE_EXTENT_BINARY_COMP card
extent_d3part Object *DATABASE_EXTENT_D3PART card
extent_intfor Object *DATABASE_EXTENT_INTFOR card
format Object *DATABASE_FORMAT card
gceout Object *DATABASE_GCEOUT card
glstat Object *DATABASE_GLSTAT card
h3out Object *DATABASE_H3OUT card
icvout Object *DATABASE_DEBOND card
icvout Object *DATABASE_ICVOUT card
jntforc Object *DATABASE_JNTFORC card
matsum Object *DATABASE_MATSUM card
ncforc Object *DATABASE_NCFORC card
nodfor Object *DATABASE_NODFOR card
nodout Object *DATABASE_NODOUT card
pbstat Object *DATABASE_PBSTAT card
pllyout Object *DATABASE_PLLYOUT card
prtube Object *DATABASE_PRTUBE card
pyro Object *DATABASE_PYRO card
rbdout Object *DATABASE_RBDOUT card
rcforc Object *DATABASE_RCFORC card
rwforc Object *DATABASE_RWFORC card
sbtout Object *DATABASE_SBTOUT card
secforc Object *DATABASE_SECFORC card
sleout Object *DATABASE_SLEOUT card
snsrout Object *DATABASE_SNSROUT card
spcforc Object *DATABASE_SPCFORC card
spgcpl Object *DATABASE_SPGSPL card
sphmassflow Object *DATABASE_SPHMASSFLOW card
sphout Object *DATABASE_SPHOUT card
swforc Object *DATABASE_SWFORC card
tprint Object *DATABASE_TPRINT card
trhist Object *DATABASE_TRHIST card

Properties for DATABASE_ABSTAT

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_ATDOUT

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_BEARING

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_BINARY

Name Type Description
blstfor Object *DATABASE_BINARY_BLSTFOR card
cpmfor Object *DATABASE_BINARY_CPMFOR card
d3crack Object *DATABASE_BINARY_D3CRACK card
d3drlf Object *DATABASE_BINARY_D3DRLF card
d3dump Object *DATABASE_BINARY_D3DUMP card
d3mean Object *DATABASE_BINARY_D3MEAN card
d3part Object *DATABASE_BINARY_D3PART card
d3plot Object *DATABASE_BINARY_D3PLOT card
d3prop Object *DATABASE_BINARY_D3PROP card
d3thdt Object *DATABASE_BINARY_D3THDT card
demfor Object *DATABASE_BINARY_DEMFOR card
fsifor Object *DATABASE_BINARY_FSIFOR card
fsilnk Object *DATABASE_BINARY_FSILNK card
intfor Object *DATABASE_BINARY_INTFOR card
isphfor Object *DATABASE_BINARY_ISPHFOR card
runrsf Object *DATABASE_BINARY_RUNRSF card
xtfile Object *DATABASE_BINARY_XTFILE card

Properties for DATABASE_BINARY_BLSTFOR

Name Type Description
dt real Time interval between outputs
exists logical true if database binary card exists
include integer The Include file number that the database binary card is in.

Properties for DATABASE_BINARY_CPMFOR

Name Type Description
dt real Time interval between outputs
exists logical true if database binary card exists
include integer The Include file number that the database binary card is in.

Properties for DATABASE_BINARY_D3CRACK

Name Type Description
dt real Time interval between outputs
exists logical true if database binary card exists
include integer The Include file number that the database binary card is in.

Properties for DATABASE_BINARY_D3DRLF

Name Type Description
cycl integer Output interval in cycles
exists logical true if database binary card exists
include integer The Include file number that the database binary card is in.

Properties for DATABASE_BINARY_D3DUMP

Name Type Description
cycl integer Output interval in cycles
exists logical true if database binary card exists
include integer The Include file number that the database binary card is in.

Properties for DATABASE_BINARY_D3MEAN

Name Type Description
dt real Time interval between outputs
exists logical true if database binary card exists
iavg integer Averaging time interval
include integer The Include file number that the database binary card is in.
istats integer Level of statistics
tstart real Start time

Properties for DATABASE_BINARY_D3PART

Name Type Description
beam integer Beam option
bsetid integer Beam Set ID
dt real Time interval between outputs
exists logical true if database binary card exists
hsetid integer Solid Set ID
include integer The Include file number that the database binary card is in.
lcdt integer Curve ID giving time interval between dumps
npltc integer Number of plot files
psetid integer Part Set ID
ssetid integer Shell Set ID
tsetid integer TShell Set ID

Properties for DATABASE_BINARY_D3PLOT

Name Type Description
beam integer Beam option
cutoff real Frequency cut-off C in Hz
dt real Time interval between outputs
exists logical true if database binary card exists
include integer The Include file number that the database binary card is in.
ioopt integer Flag for lcdt behaviour
lcdt integer Curve ID giving time interval between dumps
npltc integer Number of plot files
pset integer Part set ID for filtering
psetid integer Part Set ID
rate real Time interval T between filter sampling
type integer Flag for filtering options
window real Width of the window in units of time for storing single, forward filtering

Properties for DATABASE_BINARY_D3PROP

Name Type Description
exists logical true if database binary card exists
ifile integer Output data flag
imatl integer Output *EOS, *HOURGLASS, *MAT, *part and *SECTION data
include integer The Include file number that the database binary card is in.
iwall integer Output *RIGIDWALL data

Properties for DATABASE_BINARY_D3THDT

Name Type Description
dt real Time interval between outputs
exists logical true if database binary card exists
include integer The Include file number that the database binary card is in.
lcdt integer Curve ID giving time interval between dumps

Properties for DATABASE_BINARY_DEMFOR

Name Type Description
dt real Time interval between outputs
exists logical true if database binary card exists
include integer The Include file number that the database binary card is in.

Properties for DATABASE_BINARY_FSIFOR

Name Type Description
dt real Time interval between outputs
exists logical true if database binary card exists
include integer The Include file number that the database binary card is in.

Properties for DATABASE_BINARY_FSILNK

Name Type Description
dt real Time interval between outputs
exists logical true if database binary card exists
include integer The Include file number that the database binary card is in.

Properties for DATABASE_BINARY_INTFOR

Name Type Description
dt real Time interval between outputs
exists logical true if database binary card exists
fname string Filename of the database for the INTFOR data
include integer The Include file number that the database binary card is in.
ioopt integer governs how the plot state frequency is determined from curve LCDT
lcdt integer Curve ID giving time interval between dumps

Properties for DATABASE_BINARY_ISPHFOR

Name Type Description
dt real Time interval between outputs
exists logical true if database binary card exists
include integer The Include file number that the database binary card is in.

Properties for DATABASE_BINARY_RUNRSF

Name Type Description
cycl integer Output interval in cycles
exists logical true if database binary card exists
include integer The Include file number that the database binary card is in.
nr integer Number of running restart files

Properties for DATABASE_BINARY_XTFILE

Name Type Description
dt real Time interval between outputs
exists logical true if database binary card exists
include integer The Include file number that the database binary card is in.

Properties for DATABASE_BNDOUT

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_CURVOUT

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_DCFAIL

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_DEBOND

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_DEFGEO

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_DEFORC

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_DESTAT

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_DISBOUT

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_ELOUT

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval
option1 integer extra history variables for solids
option2 integer extra history variables for shells
option3 integer extra history variables for thick shells
option4 integer extra history variables for beams

Properties for DATABASE_ENVELOPE

Name Type Description
bsetid integer Output for beam elements. +n is output for elements in beam set n, 0 no beam, -1 all elements
exists logical true if database card exists
include integer The Include file number that the database card is in.
output integer Output format. Can be 0 or 1
ssetid integer Output for shell elements. +n is output for elements in shell set n, 0 no shell, -1 all elements
tback real Time interval for backup output files during the analysis
tcheck real Time interval for checking whether the previous maxima/minima are exceeded

Properties for DATABASE_EXTENT_BINARY

Name Type Description
beamip integer #beam int points to output
cmpflg integer Flag to output composite material stress in local csys
cubsld integer Output flag for quadratic solid types
dcomp integer Data compression flag
deleres integer Output flag for results of deleted elements
dtdt integer output of nodal temp
engflg integer Flag to in/exclude shell energy & thickness
epsflg integer Flag to in/exclude shell strains
exists logical true if database card exists
hydro integer adds extra history variables
ialemat integer output ale materials
ieverp integer Every D3PLOT file to separate database flag
include integer The Include file number that the database card is in.
intout string output of intg pt data
maxint integer #integration points for shell output
msscl integer output nodal mass scaling data
n3thdt integer Output for material energies to D3THDT file
neipb integer Output of loop-stresses to D3PLOT
neiph integer #extra values for solids
neips integer #extra values for shells
nintsld integer number of solid integration pts
nodout string output of connectivity nodes
pkp_sen integer Flag to output peak pressure and surface energy for each contact interface
quadsld integer Output flag for cubic solid types
resplt integer Output of residual forces
rltflg integer Flag to in/exclude shell force/moment resultants
sclp real Scaling parameter used in the computation of the peak pressure
shge integer Shell hourglass energy output flag
sigflg integer Flag to in/exclude shell stress tensors
strflg integer Strain tensor output flag
stssz integer Output shell element dt flag
therm integer Output of thermal data to D3PLOT

Properties for DATABASE_EXTENT_BINARY_COMP

Name Type Description
exists logical true if database card exists
iacc string output of accleration data
iglb string output of global data
include integer The Include file number that the database card is in.
ised string output of strain energy density data
istra string output of strain data
istrs string output of stress data
ivel string output of velocity data
ixyz string output of geometry data

Properties for DATABASE_EXTENT_D3PART

Name Type Description
engflg integer Flag to in/exclude shell energy & thickness
epsflg integer Flag to in/exclude shell strains
exists logical true if database card exists
ieverp integer Every D3PLOT file to separate database flag
include integer The Include file number that the database card is in.
maxint integer #integration points for shell output
neiph integer #extra values for solids
neips integer #extra values for shells
nintsld integer number of solid integration pts
rltflg integer Flag to in/exclude shell force/moment resultants
shge integer Shell hourglass energy output flag
sigflg integer Flag to in/exclude shell stress tensors
strflg integer Strain tensor output flag
stssz integer Output shell element dt flag

Properties for DATABASE_EXTENT_INTFOR

Name Type Description
exists logical true if database card exists
ieverf integer Every INTFOR database to separate file flag
include integer The Include file number that the database card is in.
neng integer Output contact energy density for mortar contact and SOFT = 2 contact
nfail integer Display deleted contact segments flag
nforc integer Output forces
ngapc integer Output contact gaps
nglbv integer Output global variables
nhuf integer Number of user friction history variables to output from user defined friction routines
npen integer Output penetration information for mortar contact
npresu integer Output pressures
nshear integer Output shear stresses
ntied integer Output tied segments for Mortar contact
nvelo integer Output nodal velocity
nwear integer Output contact wear data mode
nwrk integer Output (total) sliding interface energy density for mortar contact
nwusr integer Number of user wear history variables

Properties for DATABASE_FORMAT

Name Type Description
exists logical true if database card exists
ibinary integer Word size for binary output files
iform integer Output format for D3PLOT and D3THDT files
include integer The Include file number that the database card is in.

Properties for DATABASE_GCEOUT

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_GLSTAT

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval
mass_properties integer Flag to include mass and inertia properties

Properties for DATABASE_H3OUT

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_ICVOUT

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_JNTFORC

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_MATSUM

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_NCFORC

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_NODFOR

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_NODOUT

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval
option1 real High frequency output interval
option2 integer Flag for binary file for high frequency output

Properties for DATABASE_PBSTAT

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_PLLYOUT

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_PRTUBE

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_PYRO

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_RBDOUT

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_RCFORC

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_RWFORC

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_SBTOUT

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_SECFORC

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_SLEOUT

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_SNSROUT

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_SPCFORC

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_SPGCPL

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_SPHMASSFLOW

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_SPHOUT

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_SWFORC

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_TPRINT

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Properties for DATABASE_TRHIST

Name Type Description
binary integer Flag for binary file
dt real Time interval between output
exists logical true if database card exists
include integer The Include file number that the database card is in.
ioopt integer Flag for behaviour of load curve
lcur integer Curve ID specifying time interval

Detailed Description

The Database class allows you to create, modify, edit and manipulate database cards. Unlike other classes there is no constructor and there are no functions. Instead a Database object is available as the database property of a Model object. This object allows you to access all of the database cards. For example, to activate database card *DATABASE_SWFORC in model m and set dt to 0.001. 

m.database.swforc.exists = true;
m.database.swforc.dt = 0.001;

To activate database card *DATABASE_BINARY_D3PLOT in model m and set dt to 0.001. 

m.database.binary.d3plot.exists = true;
m.database.binary.d3plot.dt = 0.001;

See the properties for more details.