Home
Thermal Solver
Contains thermal solver related guides, such as the TMG reference manual, thermal API guide, and error message list.
Thermal solver API guide
Allows you to create or add functionality to enhance the thermal solver capabilities.
User written subroutines
This section describes two types of user-written subroutines.
Subroutine and function definitions
Subroutine definitions
Subroutine USER_QUANTITY
Gives an access to data in named user quantities.

Thermal Solver
Contains thermal solver related guides, such as the TMG reference manual, thermal API guide, and error message list.
- Thermal solver guides
  Maya HTT's thermal solver is included in Simcenter 3D and in Simcenter Femap. This page contains links to thermal solver guides, which help you understand how the thermal solver works.
- Thermal solver theory
  Describes the theory and methods of the thermal solver.
- Thermal solver API guide
  Allows you to create or add functionality to enhance the thermal solver capabilities.
  - Introduction
  - Supported compilers
  - User written subroutines
    This section describes two types of user-written subroutines.
    - USER1 subroutine
    - Interacting with the thermal solver
    - USERF subroutine
    - Specific examples
    - Subroutine and function definitions
      - Function definitions
      - Subroutine definitions
        Subroutine ADDCOND
        Adds conductances to the model. You call this routine once when KODE = 5.
        Subroutine CHANGENODECOORDS
        Changes the coordinates of a node by adding a displacement. The solver recalculates the conductive conductances of elements containing this node.
        Subroutine CMA_DEF
        Defines a set of elements that are affected by a change in attitude.
        Subroutine CMA_Orient
        Implements a change in model attitude with respect to Sun and planet.
        Subroutine CONDNOS
        Generates a list of conductances associated with an element.
        Subroutine CONDNOS2
        Returns all the conductive conductances associated with the elements of the group, including the conductances connecting the boundary elements. This routine is used only with the element CG method.
        Subroutine CREDIST2
        Returns the redistribution factors for capacitance and heat loads for element iel.
        Subroutine DESCRIP
        Accesses all the parameters associated with a Card 9 - DESCRIP Character String Descriptor Cards - Optional.
        Subroutine FAN
        Imposes a mass flow on a fan in a fluid network.
        Subroutine FASTSOLVE2
        Solves the matrix equation AX = B using the iterative biconjugate gradient method, where X is the output vector. The matrix A is created from the contents of arrays icd and cond.
        Subroutine FORMOUT
        Prints the contents of an array in TMG TEMPF file format or I-DEAS element data set type 56 universal file format. Use this routine to generate I-DEAS results from any model parameter.
        Subroutine FREE_MEMORY
        Frees the memory for array number iarr.
        Subroutine GENERIC
        Returns the parameters associated with the Card 9 - GENERIC Generic Entity Cards.
        Subroutine GENERICINDEX
        Returns the external index of a generic entity for the given internal index and the number of generic entities present in variable numgenerics. If a given internalid input value does correspond to any existing generic entity then a zeroexternalid value is returned.
        Subroutine GETLAYERS
        Returns the number of layers and a list of elements associated with a multilayer shell elements.
        Subroutine GET_MEMORY
        Allocates iel memory locations into array number iarr.
        Subroutine GET_POINTER
        Returns the pointer pntr for array number iarr.
        Subroutine GETTEMPCONDUCTIVITY
        Returns the interpolated value of the thermal conductivity at specified temperature.
        Subroutine GRP2GRP
        Calculates the heat flow through all the conductances from element groupa to element groupb.
        Subroutine HYDPROPPUT
        Sets the hydraulic property values for an element in a flow network.
        Subroutine LONGNAME
        Maps between external (user defined) and internal group names. Internal group names are limited to seven characters and may not contain spaces. To meet these requirements while avoiding group name duplication requires the change of some group names significantly.
        Subroutine NAMAR
        Returns a list of elements in a group. It uses thermal solver internal group name conventions. The group name is determined with a call to the routine LONGNAME.
        Subroutine NAMARG
        Returns internal numbers of elements in array that are associated with the group number. This subroutine is the same as subroutine NAMAR, except that it uses the group number instead of its name.
        Subroutine PELTIER
        Calculates the heat inputs to the hot and cold sides of a Peltier device.
        Subroutine ProcessMotion
        Recalculates orbital fluxes and radiation conductances for the current model configuration and attitude. The user is responsible for determining what needs to be recalculated.
        Subroutine PUT_DOUBLE
        Stores values into array.
        Subroutine PUT_INTEGER
        Stores values into array number iarr at location iel.
        Subroutine PUT_REAL
        Stores real values into array number iarr at location iel.
        Subroutine READPROP2
        Loads element properties into arrays.
        Subroutine Set_Orbital_Fluxes
        Sets new values for solar flux, planet IR and albedo.
        Subroutine SRBM_DEF
        Defines Simple Rigid Body Motion (SRBM).
        Subroutine SRBM_ MOVE
        Defines motion for an SRBM.
        Subroutine TCNAME
        Generates a list of conductances that directly join the elements in two groups, or join one group to the rest of the model.
        Subroutine TCNAMEG
        Returns the conductance array in the same format as in subroutine TCNAME, which is between two groups of elements with group numbers IGRP1 and IGRP2. This subroutine is the same as subroutine TCNAME,except that it uses the group numbers instead of their names.
        Subroutine THERMOSTAT
        Checks or sets the state of a thermostat.
        Subroutine TINT
        Returns an interpolated value from a thermal solver table. The table is defined in both cards: Card 9 - TABDATA Analyzer Table Data Cards - Optional and Card 9 - TABTYPE Table Variable Type Definition Card - Optional.
        Subroutine TMGN12
        Returns the conductance type code and the internal element numbers for a conductance.
        Subroutine TUNITS
        Returns parameters defining the units set of the model.
        Subroutine USER_QUANTITY
        Gives an access to data in named user quantities.
        Subroutine USER_TINTERP
        Calculates an interpolated temperature at the array of points contained in coords, where coords(3,numpoints) contains the X,Y,Z coordinates of a set of points. It returns the corresponding interpolated temperature values in tintp(numpoints) array.
        Subroutine USER_TINTERP2
        Calculates an interpolated temperature at the array of points contained in coords, where coords (3,numpoints) contains the X,Y,Z coordinates of a set of points.
        Subroutine USER_TINTERPINIT
        Initializes the nodal temperature interpolator on the subset of elements in the model, which is defined by the group name. It is called before using the USER_TINTERP and the USER_TINTERP2 subroutines.
        Subroutine USERARRAY
        Places or gets a value into user-defined array. The array is identified by number.
        Subroutine VARVAL
        Returns the value of the symbolic variable defined on a Card 9 - VARIABLE Variable Definition Card - Optional in the Thermal Solver Reference Manual.
    - Compiling, linking, and debugging
  - Plugin functions in expressions

Subroutine USER_QUANTITY

Gives an access to data in named user quantities.

A user quantity is a set of double precision values indexed by integer labels that is given a name and stored in memory. These labels can be element or node IDs, or an arbitrary set of non-negative integers. The data stays in memory until it is modified at a later point of the run, by another user_quantity call in the USER1 subroutine, or a similar call from user-written plugin in expression functions. Such named entities can be used for storing data from one user subroutine call to another, and/or for communicating data between user subroutine calls and user-plugin function calls. The first time a given label is used for a given user quantity name, the memory will be automatically allocated for its required storage.

Calling convention:

call user_quantity(code, name, label, value, ierr)


Arguments	Data type	Input/Output	Description
`code`	Character(*)	Call	Determines the type of data operation. Character variable value is set to: '`SET`': A value of the variable is assigned to the label for a given user quantity `name` variable. '`GET`': Returns `value` for given variables `label` and `name` inputs. '`FREE`': Clears all data for user quantity `name` variable. '`ATFIRST`' or '`NEXT`': These values are used in combination to iterate over all existing label-value pairs in a given user quantity. To perform this operation, one must first call `user_quantity` with `code` = '`ATFIRST`'. Keep calling `user_quantity` with `code` = '`NEXT`' to get the next label-value pair in `label` and `value` variables, until a non-zero value of variable `ierr` is returned.
`name`	Character(*)	Call	The user quantity name.
`label`	Integer	Both	The input value when code is ’`SET`’ or ‘`GET`’, and output value when the `code`is ’`NEXT`’. It is not used for other `code` values.
`value`	Double Precision	Both	User quantity value corresponding to the given label. The input value when code is ’`SET`’ and output value when the`code`is ’`GET`’ or ‘`NEXT`’. It is not used for other `code` values.
`ierr`	Integer	Return	The error code of the operation. `ierr` = 0 if success. `ierr` = `1` if the label is not set in a call with code = ’`GET`’.