DPF C++ client library 2023 R2

ansys::dpf::locations Struct Reference

Last update: 10.07.2023

Predefined location quantities. More...

#include <dpf_api_base.h>

Static Public Member Functions

static std::vector< Location > const & all ()
 
static void add_custom (Location const &)
 

Static Public Attributes

static const Location nodal
 
static const Location elemental
 
static const Location elemental_nodal
 
static const Location elemental_nodal_centroid
 
static const Location overall
 
static const Location nodal_elemental
 
static const Location faces
 
static const Location body
 
static const Location contact
 
static const Location joint
 
static const Location topology
 
static const Location udf_criteria
 
static const Location time_step
 
static const Location time_set
 
static const Location harmonic_index
 
static const Location phase
 
static const Location species
 
static const Location zone
 
static const Location band
 
static const Location unknown
 

Detailed Description

Predefined location quantities.

Results are evaluated at locations.

See also
Location

Member Function Documentation

◆ add_custom()

static void ansys::dpf::locations::add_custom ( Location const &  )
static

Adds a custom defined location.

◆ all()

static std::vector< Location > const & ansys::dpf::locations::all ( )
static

Gets all user-defined and predefined locations.

Returns
All locations.

Field Documentation

◆ band

const Location ansys::dpf::locations::band
static

Predefined band location.

◆ body

const Location ansys::dpf::locations::body
static

Predefined body location.

◆ contact

const Location ansys::dpf::locations::contact
static

Predefined contact location.

◆ elemental

const Location ansys::dpf::locations::elemental
static

Predefined elemental location.

Examples
AveragingTest.cpp, DataApis.cpp, DataExport.cpp, ModelTest.cpp, OperatorsApis.cpp, and WorkflowExamples.cpp.

◆ elemental_nodal

const Location ansys::dpf::locations::elemental_nodal
static

Predefined elemental_nodal location.

Examples
AveragingTest.cpp, and DataApis.cpp.

◆ elemental_nodal_centroid

const Location ansys::dpf::locations::elemental_nodal_centroid
static

Predefined elemental_nodal_centroid location.

◆ faces

const Location ansys::dpf::locations::faces
static

Predefined faces location.

◆ harmonic_index

const Location ansys::dpf::locations::harmonic_index
static

Predefined harmonic_index location.

◆ joint

const Location ansys::dpf::locations::joint
static

Predefined joint location.

◆ nodal

const Location ansys::dpf::locations::nodal
static

Predefined nodal location.

Examples
AveragingTest.cpp, DataApis.cpp, DataExport.cpp, OperatorsApis.cpp, ResultTest.cpp, and WorkflowExamples.cpp.

◆ nodal_elemental

const Location ansys::dpf::locations::nodal_elemental
static

Predefined nodal_elemental location.

◆ overall

const Location ansys::dpf::locations::overall
static

Predefined overall location.

◆ phase

const Location ansys::dpf::locations::phase
static

Predefined phase location.

◆ species

const Location ansys::dpf::locations::species
static

Predefined species location.

◆ time_set

const Location ansys::dpf::locations::time_set
static

Predefined time_set location.

Examples
DataApis.cpp.

◆ time_step

const Location ansys::dpf::locations::time_step
static

Predefined time_step location.

Examples
DataApis.cpp, and OperatorsApis.cpp.

◆ topology

const Location ansys::dpf::locations::topology
static

Predefined topology location.

◆ udf_criteria

const Location ansys::dpf::locations::udf_criteria
static

Predefined udf_criteria location.

◆ unknown

const Location ansys::dpf::locations::unknown
static

Predefined unknown location.

◆ zone

const Location ansys::dpf::locations::zone
static

Predefined zones location.

Connect with Ansys