Home
AcuSolve User-Defined Functions Manual
Customization of AcuSolve allowing you to customize certain capabilities of the solver.
Element Routines
These routines are accessible only by the Body Force, Material Model and Component Model user functions, and by external output codes.
udfGetElmIds()
Return the user element numbers.

Welcome
What's New
View new features for AcuSolve 2025.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.
- 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.
  - udfGetElmType()
    Return the type of the element set.
  - udfGetElmQuadType()
    Return the type of the quadrature rule for the element set.
  - udfGetElmNQuads()
    Return the number of quadrature points of the quadrature rule for the element set.
  - udfGetElmQuadId()
    Return the quadrature ID of the quadrature rule for the element set.
  - udfGetElmTime()
    Return the current time.
  - udfGetElmIds()
    Return the user element numbers.
  - udfGetElmCrd()
    Return the element coordinates at the quadrature point.
  - udfGetElmWDetJ()
    Return the weighted determinant of the element Jacobian at the quadrature point.
  - udfGetElmCovar()
    Return the element covariant at the quadrature point.
  - udfGetElmContvar()
    Return the element contravariant at the quadrature point.
  - udfGetElmData()
    Return the element data at the quadrature point.
  - udfGetElmJac()
    Return the array storage for the element Jacobian at the quadrature point.
  - udfGetElmAuxCrd()
    Return the auxiliary element coordinates at the quadrature point.
  - udfGetElmAuxData()
    Return auxiliary element data at the quadrature point.
  - udfGetElmRafData()
    Return element running average field data at the quadrature point.
  - udfGetElmName()
    Return the user-given name of the element set.
  - udfGetElmMedium()
    Return the medium of the element set.
  - udfGetElmNElems()
    Return the number of elements in the element set.
  - udfGetElmNElemNodes()
    Return the number of element nodes for the element set.
  - udfGetElmCnn()
    Return the element connectivity.
- 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

udfGetElmIds()

Return the user element numbers.

Syntax

elemIds = udfGetElmIds( udfHd ) ;

Type

User Defined Element

Parameters

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

Return Value

elemIds (Integer*): Pointer to one-dimensional integer array of user element numbers. This array has a dimension of number of elements, nItems.

Description

This routine returns the array of user element numbers. This is the first array column of the parameter elements of the command ELEMENT_SET in the input file. For example,

Integer* elemIds ;
Integer usrElem, elem ;
...
elemIds = udfGetElmIds( udfHd ) ;
for ( elem = 0 ; elem < nItems ; elem++ ) {
   usrElem = elemIds[elem] ;
 ...
}

Errors

This routine expects a valid udfHd.
This routine may only be called within a Body Force, Material Model or Component Model user function.