Home
Thermal Solver
Contains thermal solver related guides, such as the TMG reference manual, thermal API guide, and error message list.
Thermal solver API
Allows you to create or add functionality to enhance the thermal solver capabilities.
Plugin functions in expressions
Simcenter 3D method definitions
AddFunction
This method is used to register a function pointer with the expression. It returns an IFunctionDefinition interface that allows you to define any arguments this function requires.

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 reference
  Describes the format and contents of the thermal solver's input and output files
- Thermal solver theory
  Describes the theory and methods of the thermal solver.
- Thermal solver API
  Allows you to create or add functionality to enhance the thermal solver capabilities.
  - Introduction
  - User written subroutines
    This section describes two types of user-written subroutines.
  - Plugin functions in expressions
    - Workflow for using a plugin function
      The following example walks you through the steps of creating a plugin function that you can then use in your model.
    - API methods for plugin function
      You use the predefined API methods to define your plugin function. API methods are divided into methods supported by Simcenter 3D and methods supported by the thermal solver.
    - Simcenter 3D method definitions
      - AddArg
        This method defines required arguments to your plugin function.
      - AddFunction
        This method is used to register a function pointer with the expression. It returns an IFunctionDefinition interface that allows you to define any arguments this function requires.
      - AddOptionalArg
        This method defines optional arguments foryour plugin function. You can call AddOptionalArg, only after call the AddArg method.
      - GetDensity
        Returns the material's density for a given temperature and pressure.
      - GetElemID
        Returns the current element ID.
      - GetEnthalpy
        Returns the material's enthalpy for a given temperature and pressure.
      - GetFieldProperty
        Returns the value for the material property, if the property is available as a field. The name of the property is specified by the argument string.
      - GetFluidMassFlowRate
        Returns the fluid mass flow rate computed at the element centroid to which the thermal streams, thermal voids, or thermal convecting zones boundary condition is applied.
      - GetFluidMaterial
        Returns the fluid material associated to the element to which the thermal streams, thermal voids, or thermal convecting zones boundary condition is applied.
      - GetFluidPressure
        Returns the fluid pressure computed at the element centroid to which the thermal streams, thermal voids, or thermal convecting zones boundary condition is applied.
      - GetFluidTemp
        Returns the fluid temperature computed at the element centroid to which the thermal streams, thermal voids, or thermal convecting zones boundary condition is applied.
      - GetMaterial
        Returns the material associated to the element.
      - GetNodeID
        Returns a true or false value depending on if the quantity is computed on nodes or not. Use it in conjunction with the Finite Element Method. When the operation is successful, the function puts the node ID associated with the current expression call in the argument.
      - GetRadius
        Returns the radius of the element centroid with respect to the absolute cylindrical coordinate system.
      - GetRotationalSpeed
        Returns the rotational speed computed at the element centroid.
      - GetScalarProperty
        Returns the value for the material property, if the property is available as a scalar. The name of the property is specified by the argument string.
      - GetSpecificHeat
        Returns the material's specific heat for a given temperature and pressure.
      - GetUnitSystem
        Returns the unit system of the solution.
      - GetTemperature
        Returns the temperature of the current element.
      - GetThermalConductivity
        Returns the material's thermal conductivity for a given temperature and pressure.
      - GetThickness
        Returns the element thickness. For solid elements, it returns 0 thickness.
      - GetTime
        Returns the current time of a transient solution.
      - GetX, GetY, GetZ
        Return the X, Y, and Z coordinates of the element centroid with respect to the absolute coordinate system.
      - HasProperty
        This method checks if the thermal solver supports the property for a given material.
      - Set
        This method specifies power orders using the mass, length, time (MLT) system. When you add your plugin function, you must specify the unit dimensions of the physical quantity that is returned by your function, and for any arguments used by your function. The unit dimensions are specified through the instance of class Measure.
      - StopRun
        Aborts the solve from within a plugin function.
    - Thermal solver method definitions
- Thermal solver error message list
  Lists solver messages that the thermal solver generates to communicate issues with the model or the solve.

AddFunction

This method is used to register a function pointer with the expression. It returns an IFunctionDefinition interface that allows you to define any arguments this function requires.

Calling convention:

AddFunction (const char* funcName, const char* funcDescription, Measure  returnDimens, ArgType  returnType, const char*  returnDescription, RegFuncPtr ptrToFunc)


Argument	Data type	Description
funcName	const char*	Name of your plugin function used in a boundary condition.
funcDescription	const char*	Description of your plugin function.
returnDimens	Measure	Unit dimension for the returned value.
returnType	ArgType	Return value data type.
returnDescription	const char*	Name for the returned unit dimension.
ptrToFunc	RegFuncPtr	Pointer of your implemented function.

You can find a definition of this function in the CaeUtils_Exp_IRegistrar.hxx header file.

Example:

void AddHTCCustom(IRegistrar* pReg)
  {
      Measure meas;
      meas.Set(1, 0, -3, 0, 0, 0, -1, 0, 0);
      IFunctionDefinition* pFunc = pReg->AddFunction(
      "HTCCustom"
      "Return heat transfer coefficient from a free disc with turbulent flow"
      meas,
      TYP_DBL,
      "Heat transfer coefficient",
      &HTCCustom)
  }