This subroutine is used to specify the implicit/explicit character of the equations governing the GSE.
See the definition of the IMPLICIT attribute in the documentation for the GSE statement.
When the GSE is initialized Adams Solver (C++) will look for a GSE_SET_IMPLICIT entry point in the GSE (if it was not explicitly specified using the INTERFACE= attribute). If GSE_SET_IMPLICIT is present, then during initialization of the GSE this subroutine will be called.
Notes: | ■The value returned by GSE_SET_IMPLICIT will override any IMPLICIT attribute setting that is specified in the GSE statement. ■Use mixed case names for the Adams subroutine names when using the C style interface. For the default subroutine name capitalize the first letter and have the remaining letters lower case. Doing this ensures that Adams Solver correctly distinguishes a C style subroutine from Fortran and calls with the appropriate interface. |
This user-defined subroutine is new for Adams Solver (C++) v2006r1 and gives the GSE the ability to define the implicit/explicit character of its governing equations. That is, the formulation of a GSE can be changed without changing the corresponding adams model (.amd).
Calling Sequence and Structure
SUBROUTINE GSE_SET_IMPLICIT (ID, IMPLICIT)
Input Arguments
ID | An integer variable that gives the identifier of the GSE statement requesting information from the GSE subroutine. From the identifier, Adams Solver automatically recognizes other information (such as the Par argument) that is associated with that GSE statement. |
Output Arguments
IMPLICIT | An integer specifying whether the GSE formulation is implicit or explicit. A nonzero (true) value for IMPLICIT specifies an implicit formulation. |
Example
C
C+===============================================================*
C
SUBROUTINE GSE_SET_IMPLICIT (ID, IMPLICIT)
C
C Inputs:
C
INTEGER ID
C
C Outputs:
C
INTEGER IMPLICIT
C
C This GSE is formulated implicitly.
IMPLICIT = 1
RETURN
END
C
C+===============================================================*
C