Utility Routine Interface
Fortran:
DIMENSION ARRAY(15), JARRAY(15)
CHARACTER*3 FLGRAY(15)
CALL GETVRM('VAR',ARRAY,JARRAY,FLGRAY,JRCD,JMAC,JMATYP,MATLAYO,
LACCFLA)
or
C++:
#include <SMAAspUserSubroutines.h>
void getVrmC(const char* var, double* array, int* jarray, std::vector<std::string> &flgray,
int &jrcd, int* jmac, int* jmtyp, int* matlayo, int* laccfla);
Variables to Be Provided to the Utility Routine
-
VAR
-
Output variable key from the table in Element Integration Point Variables. The applicable keys are listed in the output table as
being available for results file output at the element integration points; for
example, S for stress.
-
JMAC
-
Variable that must be passed into the
GETVRM utility routine. The calling user
subroutine provides this variable.
-
JMATYP
-
Variable that must be passed into the
GETVRM utility routine. The calling user
subroutine provides this variable.
-
MATLAYO
-
Variable that must be passed into the
GETVRM utility routine. The calling user
subroutine provides this variable.
-
LACCFLA
-
Variable that must be passed into the
GETVRM utility routine. The calling user
subroutine provides this variable.
Variables Returned from the Utility Routine
-
ARRAY
-
Real array containing individual components of the output variable.
-
JARRAY
-
Integer array containing individual components of the output variable.
-
FLGRAY
-
Character array containing flags corresponding to the individual components. Flags
will contain either YES,
NO, or N/A (not applicable).
-
JRCD
-
Return code (0 – no error, 1 – output request error or all components of the output
request are zero).
Available Output Variable Keys
Only output variable keys that are valid for results file output are available for use with
GETVRM. In a static perturbation procedure,
only those output variables for which perturbation values are available can be accessed. In
general, if a key corresponds to a collective output variable, rather than an individual
component, it can be used with GETVRM. For
example, S for the stress tensor can be
used, whereas any individual component of stress, say
S11, cannot be used. The collective output
variable keys are distinguished from their individual components in that they have the word
"yes" after the category .fil in the tables in Using Abaqus/Standard Output Variable Identifiers. Output variable keys that cannot be used with
GETVRM are listed later in this section.
You will be returned ARRAY,
JARRAY, and FLGRAY, which
correspond to the real-valued components, integer-valued components, and the flags
associated with the request VAR, respectively. If any array
component is not applicable for a given request, its value will be returned as the
initialized value: 0.0 in ARRAY, 0 in
JARRAY, and N/A in FLGRAY.
The error flag JRCD=1 is returned from
GETVRM any time a request key is not
recognized, the request is not valid (such as requesting transverse shear stress for a shell
element that uses thin shell theory), or all the output components requested are zero;
otherwise, JRCD=0.
Ordering of Returned Components
The components for a request are written as follows. Single index components (and requests
without components) are returned in positions 1, 2, 3, etc. Double index components are
returned in the order 11, 22, 33, 12, 13, 23 for symmetric tensors, followed by 21, 31, 32
for unsymmetric tensors (deformation gradient). Thus, the stresses for a plane stress
element are returned as
ARRAY(1)=S11,
ARRAY(2)=S22,
ARRAY(3)=0.0, and
ARRAY(4)=S12.
Three values are always returned for principal value requests, the minimum value first and
maximum value third, regardless of the dimensionality of the analysis.
The description of the output variable (see Abaqus/Standard Output Variable Identifiers) determines
which components are retrieved with GETVRM.
Analysis Time for Which Values Are Returned
When a material point quantity is requested with utility routine
GETVRM, the time in the increment at which the
values are returned will depend on which user subroutine calls it.
GETVRM returns values at the end of the
current increment to user subroutine UVARM, whereas it returns values at
the beginning of the current increment to user subroutine USDFLD.
Equilibrium State for Values Returned
User subroutine UVARM might call
GETVRM multiple times for each increment, as
Abaqus/Standard iterates to a converged solution. Values returned from
GETVRM calls preceding the final iteration for
the increment will not represent the converged solution.
Example
If you specify the identifier PEQC for
use with a jointed material or a material with the cap plasticity model,
ARRAY is returned with the individual equivalent plastic
strain components PEQC1,
PEQC2,
PEQC3, and
PEQC4. Since there are no integer output
variables associated with this identifier, JARRAY is returned
with default values of 0. The FLGRAY array contains either
YES or
NO flags indicating whether each
component is actively yielding.
If you specify the identifier PE for a
material with plasticity except with the cap plasticity model,
ARRAY is returned with plastic strain components
PE11,
PE22,
PE33,
PE12,
PE13,
PE23, the equivalent plastic strain
PEEQ, and the plastic strain magnitude
PEMAG. Since there are no integer values
associated with this request, JARRAY is 0. The
FLGRAY array contains N/A for the first six components,
either YES or
NO in the seventh component
(corresponding to PEEQ) indicating whether
the material is currently yielding, and N/A in the eighth component.
If you specify the identifier PE for a
material with the cap plasticity model, ARRAY is returned
with plastic strain components PE11,
PE22,
PE33,
PE12,
PE13,
PE23, the cap position
PBCAP, and the plastic strain magnitude
PEMAG. Since there are no integer values
associated with this request, JARRAY is 0. The
FLGRAY array contains N/A for all eight components.
If you specify the identifier CE,
ARRAY is returned with its seventh, eighth, and ninth
components equal to CEEQ,
CESW, and
CEMAG, respectively.
If you specify the identifier VE,
ARRAY is returned with its seventh component equal to
VEEQ.
If you specify the identifier HFL,
ARRAY is returned with the magnitude
HFLM and the components
HFL1,
HFL2, and
HFL3 as described in Abaqus/Standard Output Variable Identifiers.
Accessing State-Dependent Variables
If GETVRM is used to access state-dependent
variables (output variable key SDV) and
more than 15 state-dependent variables have been defined in the analysis, the dimension
statement for ARRAY and JARRAY
must be changed so that these arrays are dimensioned to the maximum number of
state-dependent variables.
Accessing Parallel Rheological Framework Variables
The components of the output variables
CEEQNET,
CEEQSSNET, and
SDEFRESNET specific to the parallel
rheological framework (Parallel Rheological Framework) are returned in the
order of increasing network identification numbers in the real-valued output array
ARRAY. In addition, the identification numbers of the
corresponding networks associated with the values in ARRAY
are included in the integer-valued array JARRAY. The size of
ARRAY and JARRAY for these
request variables is as follows:
| Variable identifier (VAR) |
Size of ARRAY and
JARRAY |
| CEEQNET |
Total number of viscous networks |
| CEEQSSNET |
Number of viscous networks using the modified Darveaux model |
| SDEFRESNET |
Number of viscous networks using the Anand model |
For example, consider a PRF model with four viscous
networks with creep laws:
| Network identification number |
Creep law |
| 1 |
Hyperbolic-Sine model |
| 2 |
Anand model |
| 3 |
Modified Darveaux Model |
| 4 |
Anand model |
The components of ARRAY and
JARRAY for requests
CEEQNET,
CEEQSSNET, and
SDEFRESNET, are:
| Component |
ARRAY |
JARRAY |
| 1 |
CEEQNET1 |
1 |
| 2 |
CEEQNET2 |
2 |
| 3 |
CEEQNET3 |
3 |
| 4 |
CEEQNET4 |
4 |
| Component |
ARRAY |
JARRAY |
| 1 |
CEEQSSNET3 |
3 |
| Component |
ARRAY |
JARRAY |
| 1 |
SDEFRESNET2 |
2 |
| 2 |
SDEFRESNET4 |
4 |
If GETVRM is used to access state-dependent
variables output variables specific to the parallel rheological framework (output variable
key CEEQNET,
CEEQSSNET,
SDEFRESNET) and more than 15 networks have
been defined in a PRF material, the dimension statement for
ARRAY and JARRAY might need
to be modified so that these arrays are dimensioned appropriately.
Unsupported Element Types, Procedures, and Output Variable Keys
Since this capability pertains to material point quantities, it cannot be used for most of
the element types that do not require a material definition. The following element types
are, therefore, not supported:
If used with user subroutine UVARM, this capability is available
for static perturbation procedures but not for any other linear perturbation procedures
(General and Perturbation Procedures):
The following output variable keys are not available for use with
GETVRM:
-
SVOL
-
TSHR
-
CTSHR
-
COORD
-
UVARPT
|