Home
AcuSolve User-Defined Functions Manual
Customization of AcuSolve allowing you to customize certain capabilities of the solver.
Basic Routines
These routines are accessible by all user functions, and by external output codes.
udfGetType()
Get the type of the user-defined function.

Welcome
What's New
View new features for AcuSolve 2024.1.
Get Started
AcuSolve is a leading general purpose CFD solver that is capable of solving the most demanding industrial and scientific applications.
Tutorials
Discover AcuSolve functionality with interactive tutorials.
AcuSolve Training Manual
Introduction of background knowledge regarding flow physics and CFD as well as detailed information about the use of AcuSolve and what specific options do.
AcuSolve Validation Manual
Collection of AcuSolve simulation cases for which results are compared against analytical or experimental results to demonstrate the accuracy of AcuSolve results.
AcuSolve Command Reference Manual
AcuSolve command descriptions and corresponding examples.
AcuSolve Programs Reference Manual
AcuSolve utility programs covering preparatory and post-processing as well as user-defined functions and utility scripts.
AcuSolve User-Defined Functions Manual
Customization of AcuSolve allowing you to customize certain capabilities of the solver.
- Input File
  To access a user-defined function in AcuSolve, you must reference it in the input file.
- Function Format
  A user-defined function has the following form (in C).
- Compile, Link and Run
  In order for the solver to access the user-defined functions, the functions must be compiled and linked into a shared library. The script acuMakeLib (for Linux) and acuMakeDll (for Windows) may be used for this purpose.
- Support Routines
  Within a user-defined function or an external output code data may be accessed through support routines. These routines provide flexibility, longevity, efficiency and the ability to check for run-time errors.
- Basic Routines
  These routines are accessible by all user functions, and by external output codes.
  - udfGetType()
    Get the type of the user-defined function.
  - udfGetProcld()
    Return the processor ID.
  - udfGetName()
    Return the user-given name of the input command associated with the user function.
  - udfCheckNumUsrVals()
    Check the number of user values given in the input file.
  - udfGetNumUsrVals()
    Return the number of user values supplied in the input file.
  - udfGetUsrVals()
    Return the array of user-supplied values.
  - udfCheckNumUsrStrs()
    Check the number of user strings given in the input file.
  - udfGetNumUsrStrs()
    Return the number of user strings supplied in the input file.
  - udfGetUsrStrs()
    Return the array of user supplied strings.
  - udfCheckNumUsrHists()
    Check the number of user history variables given in the input file.
  - udfGetNumUsrHists()
    Return the number of user history variables supplied in the input file.
  - udfGetUsrHistsCurr()
    Return the array of current history variables.
  - udfGetUsrHistsPrev()
    Return the array of history variables from the previous time step.
  - udfFirstCall()
    Determine whether this the first time a user-defined function is called.
  - udfFirstStep()
    Determine whether this is the initial time step of this run.
  - udfSetError()
    Print an error message and exit the solver.
  - udfPrintMess()
    Print a message to the standard output, or .log file, if active.
  - udfPrintMessPrim()
    Print a message to the standard output, or .log file, if active, for the primary processor/subdomain.
  - udfSetSig()
    Set a signal to alter the behavior of AcuSolve.
  - udfPrim()
    Determine whether this the primary processor/subdomain.
  - udfBcastVector()
    Broadcast a vector to all processors from the primary processor/subdomain.
  - udfSetUsrHandle()
    Save the handle (pointer) to user data for future retrieval.
  - udfGetUsrHandle()
    Return the handle (pointer) to previously saved user data.
- Client/Server Routines
  These routines are accessible only by multiplier function and mesh motion user functions.
- Global Routines
  These routines are accessible by all user functions, and by external output codes.
- Element Routines
  These routines are accessible only by the Body Force, Material Model and Component Model user functions, and by external output codes.
- Element Boundary Condition Routines
  These support routines are accessible only by the Element Boundary Condition user functions, and by external output codes.
- Nodal Boundary Condition Routines
  These support routines are accessible only by the Nodal Boundary Condition user functions.
- Nodal Initial Condition Routines
  These support routines are accessible only by the Nodal Initial Condition user functions.
- Periodic Boundary Condition Routines
  These support routines are accessible only by the Periodic Boundary Condition user functions.
- Subdomain Routines
  These support routines are accessible only within external output codes.
AcuTrace Command Reference Manual
Commands of AcuTrace, a particle tracer that runs as a post-processor to or a co-processor with AcuSolve.
AcuTrace User-Defined Functions Manual
Instructions to define additional solution quantities of AcuTrace called user equations.
AcuReport Reference Manual
Instruction of the AcuReport tool, a standalone post-processor batch tool used to generate a report from an AcuSolve solution database.
AcuSolve Surface Processing

View All Altair HyperWorks Help

udfGetType()

Get the type of the user-defined function.

Syntax

type = udfGetType( udfHd ) ;

Type

AcuSolve User-Defined Function Basic

Parameters

udfHd: The opaque handle (pointer) which was passed to the user function.

Return Value

type (integer)

The returned type can have several different values, depending on the user-defined function type:

Returned Type Value: Meaning of Type Value
UDF_MULT_FUNCTION: Multiplier function.
UDF_NODAL_BC: Nodal boundary condition.
UDF_NODAL_BC_DIR: Nodal BC direction vector.
UDF_PERIODIC_BC: Periodic boundary condition.
UDF_ELEMENT_COMPONENT: Element component (fan or heat exchanger).
UDF_ELEMENT_BC: Element boundary condition.
UDF_VISCOSITY: Element viscosity.
UDF_CONDUCTIVITY: Element thermal conductivity.
UDF_DIFFUSIVITY: Element species diffusivity.
UDF_GRAVITY: Element gravity (generalized volumetric body force).
UDF_MASS_HEAT_SOURCE: Element heat source per unit mass.
UDF_VOLUME_HEAT_SOURCE: Element heat source per unit volume.
UDF_MASS_SPECIES_SOURCE: Element species source per unit mass.
UDF_VOLUME_SPECIES_SOURCE: Element species source per unit volume.
UDF_EMISSIVITY: Radiation surface emissivity.
UDF_DENSITY: Element density.
UDF_SPECIFIC_HEAT: Element enthalpy.
UDF_MESH_MOTION: Mesh motion.
UDF_ELEMENT_OUTPUT: Element output.
UDF_SURFACE_TENSION: Surface tension.
UDF_CONTACT_ANGLE: Contact angle.
UDF_FLEXIBLE_BODY: Flexible body.
UDF_VISCOELASTIC: Viscoelastic model.

Description

This routine returns the type of the user-defined function. This routine may be used to determine the expected return value of the function. Among other usages, this allows a single routine to be used for multiple objectives. For example,

Integer type ;
...
type = udfGetType( udfHd ) ;
UDF_PROTOTYPE(usrFunc) ;
if ( type == UDF_VISCOSITY ) {
    /* compute viscosity */
    ...
} else if ( type == UDF_CONDUCTIVITY ) {
    /* compute thermal conductivity */
    ...
} else {
udfSetError( udfHd, "Invalid type %d", type ) ;
}

Errors

This routine expects a valid udfHd as an argument. An invalid argument returns an error.