Home
AcuSolve User-Defined Functions Manual
Customization of AcuSolve allowing you to customize certain capabilities of the solver.
Element Boundary Condition Routines
These support routines are accessible only by the Element Boundary Condition user functions, and by external output codes.
udfGetEbcRafData()
Return running average field data at the surface quadrature point.

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.
- 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.
  - udfGetEbcType()
    Return the type of the surface set.
  - udfGetEbcQuadType()
    Return the type of the quadrature rule for the surface set.
  - udfGetEbcNQuads()
    Return the number of quadrature points of the quadrature rule for the surface set.
  - udfGetEbcQuadId()
    Return the quadrature point ID of the quadrature rule for the surface set.
  - udfGetEbcTime()
    Return the current time.
  - udfGetEbcIds()
    Return element boundary condition user surface numbers.
  - udfGetEbcCrd()
    Return coordinates of the surface quadrature point.
  - udfGetEbcWDetJ()
    Return the weighted determinant of the surface Jacobian at the surface quadrature point.
  - udfGetEbcNormDir()
    Return the outward normal direction of the surface at the surface quadrature point.
  - udfGetEbcCovar()
    Return the surface covariant at the surface quadrature point.
  - udfGetEbcContvar()
    Return the surface contravariant at the surface quadrature point.
  - udfGetEbcJac()
    Return the array storage for the surface element Jacobian at the quadrature point.
  - udfGetEbcData()
    Return data at the surface quadrature point.
  - udfGetEbcRafData()
    Return running average field data at the surface quadrature point.
  - udfGetEbcName()
    Return the user-given name of the boundary element set.
  - udfGetEbcMedium()
    Return the medium of the boundary element set.
  - udfGetEbcNElems()
    Return the number of elements in the boundary element set.
  - udfGetEbcNElemNodes()
    Return the number of element nodes for the boundary element set.
  - udfGetEbcCnn()
    Return the element connectivity.
- 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

udfGetEbcRafData()

Return running average field data at the surface quadrature point.

Syntax

data = udfGetEbcRafData( udfHd, dataName ) ;

Type

AcuSolve User-Defined Example Boundary Condition

Parameters

udfHd

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

dataName (integer)

Symbolic name of the requested data.

UDF_EBC_VELOCITY: Velocity.
UDF_EBC_ACCELERATION: Acceleration.
UDF_EBC_PRESSURE: Pressure.
UDF_EBC_TEMPERATURE: Temperature.
UDF_EBC_SPECIES: Species.
UDF_EBC_EDDY_VISCOSITY: Turbulence eddy viscosity.
UDF_EBC_KINETIC_ENERGY: Turbulence kinetic energy.
UDF_EBC_EDDY_FREQUENCY: Turbulence eddy frequency.
UDF_EBC_GRAD_VELOCITY: Gradient of velocity.
UDF_EBC_GRAD_PRESSURE: Gradient of pressure.
UDF_EBC_GRAD_TEMPERATURE: Gradient of temperature.
UDF_EBC_GRAD_SPECIES: Gradient of species.
UDF_EBC_MESH_DISPLACEMENT: Mesh displacement.
UDF_EBC_MESH_VELOCITY: Mesh velocity.

Return Value

data (Real*)

Pointer to one, two, or three dimensional real array of the requested data. The dimensions of the array depend on dataName as follows. If the third (slowest) dimension of the array is equal to one, then the array may be treated as two dimensional. If the second dimension is likewise one, then the array is one dimensional. The x, y, z components of the gradient for gradient quantities are always contained in the last nontrivial dimension.


dataName	First Dimension	Second Dimension	Third Dimension
UDF_EBC_VELOCITY	nItems	3	1
UDF_EBC_ACCLERATION	nItems	3	1
UDF_EBC_PRESSURE	nItems	1	1
UDF_EBC_TEMPERATURE	nItems	1	1
UDF_EBC_SPECIES	nItems	udfGetNumSpecs()	1
UDF_EBC_EDDY_VISCOSITY	nItems	1	1
UDF_EBC_KINETIC_ENERGY	nItems	1	1
UDF_EBC_EDDY_FREQUENCY	nItems	1	1
UDF_EBC_GRAD_VELOCITY	nItems	3	3
UDF_EBC_GRAD_PRESSURE	nItems	3	1
UDF_EBC_GRAD_TEMPERATURE	nItems	3	1
UDF_EBC_GRAD_SPECIES	nItems	udfGetNumSpecs()	3
UDF_EBC_MESH_DISPLACEMENT	nItems	3	1
UDF_EBC_MESH_VELOCITY	nItems	3	1

Description

This routine returns the requested solution data at the surface quadrature point. It is used exactly the same way as, but returns the running average field versions of the data.

Errors

This routine expects a valid udfHd.
This routine may only be called within an Element Boundary Condition user function.
dataName must be one of the values given above.
The problem must contain the equation associated with the requested data.
running_average must be turned on in the EQUATION command.