## On this page

  

 

 # ansys::dpf::locations Struct Reference

 Last update: 16.07.2025 

Predefined location quantities. [More...](structansys_1_1dpf_1_1locations.xhtml#details)

`#include <dpf_api_base.h>`

## <a id="pub-static-methods" name="pub-static-methods"></a>Static Public Member Functions

static std::vector&lt; [Location](structansys_1_1dpf_1_1Location.xhtml) &gt; const &amp; [all](structansys_1_1dpf_1_1locations.xhtml#a271a9fed8a1f57c015715167a8ce72c0) () static void [add\_custom](structansys_1_1dpf_1_1locations.xhtml#a2b734a87208388ed01d8cb587043405b) ([Location](structansys_1_1dpf_1_1Location.xhtml) const &amp;) ## <a id="pub-static-attribs" name="pub-static-attribs"></a>Static Public Attributes

static const [Location](structansys_1_1dpf_1_1Location.xhtml) [nodal](structansys_1_1dpf_1_1locations.xhtml#aa4e1967b0838d8597200c606c8564d29) static const [Location](structansys_1_1dpf_1_1Location.xhtml) [elemental](structansys_1_1dpf_1_1locations.xhtml#a3f66169a86ab935fb398b3fdde98bb04) static const [Location](structansys_1_1dpf_1_1Location.xhtml) [elemental\_nodal](structansys_1_1dpf_1_1locations.xhtml#a0bda534055805adc4c08bece34989ff3) static const [Location](structansys_1_1dpf_1_1Location.xhtml) [elemental\_nodal\_centroid](structansys_1_1dpf_1_1locations.xhtml#a5b54316cebce849e6a8489d19a990246) static const [Location](structansys_1_1dpf_1_1Location.xhtml) [overall](structansys_1_1dpf_1_1locations.xhtml#ada5a62dea9a6a1bf156f90282a273959) static const [Location](structansys_1_1dpf_1_1Location.xhtml) [nodal\_elemental](structansys_1_1dpf_1_1locations.xhtml#aba56d24e91e52e4742ee5505dff04b94) static const [Location](structansys_1_1dpf_1_1Location.xhtml) [faces](structansys_1_1dpf_1_1locations.xhtml#a111716841842157a978ebebdc9c503b6) static const [Location](structansys_1_1dpf_1_1Location.xhtml) [body](structansys_1_1dpf_1_1locations.xhtml#acfb36fa3e6c22d12b971fdf941d6dab8) static const [Location](structansys_1_1dpf_1_1Location.xhtml) [contact](structansys_1_1dpf_1_1locations.xhtml#ae0384994ee793ef9de351b28c49ba706) static const [Location](structansys_1_1dpf_1_1Location.xhtml) [joint](structansys_1_1dpf_1_1locations.xhtml#a0a7d57a4476a34178090d4fa96f0c550) static const [Location](structansys_1_1dpf_1_1Location.xhtml) [topology](structansys_1_1dpf_1_1locations.xhtml#a3049c32b1dc96441810bd53803916a58) static const [Location](structansys_1_1dpf_1_1Location.xhtml) [udf\_criteria](structansys_1_1dpf_1_1locations.xhtml#af0cfa3922b89f1b5be079a47a714241a) static const [Location](structansys_1_1dpf_1_1Location.xhtml) [time\_step](structansys_1_1dpf_1_1locations.xhtml#abc48364ef6b184ddf696099c9a2993cd) static const [Location](structansys_1_1dpf_1_1Location.xhtml) [time\_set](structansys_1_1dpf_1_1locations.xhtml#a3cf1bbc2ad6d8b8f6173e83b5118031a) static const [Location](structansys_1_1dpf_1_1Location.xhtml) [harmonic\_index](structansys_1_1dpf_1_1locations.xhtml#a46ac72d7066346bc309dfb44de1a20cf) static const [Location](structansys_1_1dpf_1_1Location.xhtml) [phase](structansys_1_1dpf_1_1locations.xhtml#abaf9f2158d14707096139ab5eb27d70d) static const [Location](structansys_1_1dpf_1_1Location.xhtml) [species](structansys_1_1dpf_1_1locations.xhtml#a76bdfc819d94d708b849281adf480677) static const [Location](structansys_1_1dpf_1_1Location.xhtml) [zone](structansys_1_1dpf_1_1locations.xhtml#a2c1aea4cc98bb70ffb146a163121b8e4) static const [Location](structansys_1_1dpf_1_1Location.xhtml) [band](structansys_1_1dpf_1_1locations.xhtml#a6441fe6518684351e3f3f7ba52396615) static const [Location](structansys_1_1dpf_1_1Location.xhtml) [unknown](structansys_1_1dpf_1_1locations.xhtml#a223dc0f57d600b9acf15ac72a603835c) <a id="details" name="details"></a>## Detailed Description

Predefined location quantities.

Results are evaluated at locations.

See also[Location](structansys_1_1dpf_1_1Location.xhtml "User defined location quantity.")

## Member Function Documentation

<a id="a2b734a87208388ed01d8cb587043405b" name="a2b734a87208388ed01d8cb587043405b"></a>## [◆ ](#a2b734a87208388ed01d8cb587043405b)add\_custom()

 static void ansys::dpf::locations::add\_custom  ( [Location](structansys_1_1dpf_1_1Location.xhtml) const &amp;  )   static 

Adds a custom defined location.





<a id="a271a9fed8a1f57c015715167a8ce72c0" name="a271a9fed8a1f57c015715167a8ce72c0"></a>## [◆ ](#a271a9fed8a1f57c015715167a8ce72c0)all()

 static std::vector&lt; [Location](structansys_1_1dpf_1_1Location.xhtml) &gt; const &amp; ansys::dpf::locations::all  ( )   static 

Gets all user-defined and predefined locations.

ReturnsAll locations. 



## Field Documentation

<a id="a6441fe6518684351e3f3f7ba52396615" name="a6441fe6518684351e3f3f7ba52396615"></a>## [◆ ](#a6441fe6518684351e3f3f7ba52396615)band

 const [Location](structansys_1_1dpf_1_1Location.xhtml) ansys::dpf::locations::band  static 

Predefined band location.





<a id="acfb36fa3e6c22d12b971fdf941d6dab8" name="acfb36fa3e6c22d12b971fdf941d6dab8"></a>## [◆ ](#acfb36fa3e6c22d12b971fdf941d6dab8)body

 const [Location](structansys_1_1dpf_1_1Location.xhtml) ansys::dpf::locations::body  static 

Predefined body location.





<a id="ae0384994ee793ef9de351b28c49ba706" name="ae0384994ee793ef9de351b28c49ba706"></a>## [◆ ](#ae0384994ee793ef9de351b28c49ba706)contact

 const [Location](structansys_1_1dpf_1_1Location.xhtml) ansys::dpf::locations::contact  static 

Predefined contact location.





<a id="a3f66169a86ab935fb398b3fdde98bb04" name="a3f66169a86ab935fb398b3fdde98bb04"></a>## [◆ ](#a3f66169a86ab935fb398b3fdde98bb04)elemental

 const [Location](structansys_1_1dpf_1_1Location.xhtml) ansys::dpf::locations::elemental  static 

Predefined elemental location.

Examples[AveragingTest.cpp](AveragingTest_8cpp-example.xhtml#a15), [DataApis.cpp](DataApis_8cpp-example.xhtml#a16), [DataExport.cpp](DataExport_8cpp-example.xhtml#a30), [ModelTest.cpp](ModelTest_8cpp-example.xhtml#a42), [OperatorsApis.cpp](OperatorsApis_8cpp-example.xhtml#a12), and [WorkflowExamples.cpp](WorkflowExamples_8cpp-example.xhtml#a13).



<a id="a0bda534055805adc4c08bece34989ff3" name="a0bda534055805adc4c08bece34989ff3"></a>## [◆ ](#a0bda534055805adc4c08bece34989ff3)elemental\_nodal

 const [Location](structansys_1_1dpf_1_1Location.xhtml) ansys::dpf::locations::elemental\_nodal  static 

Predefined elemental\_nodal location.

Examples[AveragingTest.cpp](AveragingTest_8cpp-example.xhtml#a12), and [DataApis.cpp](DataApis_8cpp-example.xhtml#a15).



<a id="a5b54316cebce849e6a8489d19a990246" name="a5b54316cebce849e6a8489d19a990246"></a>## [◆ ](#a5b54316cebce849e6a8489d19a990246)elemental\_nodal\_centroid

 const [Location](structansys_1_1dpf_1_1Location.xhtml) ansys::dpf::locations::elemental\_nodal\_centroid  static 

Predefined elemental\_nodal\_centroid location.





<a id="a111716841842157a978ebebdc9c503b6" name="a111716841842157a978ebebdc9c503b6"></a>## [◆ ](#a111716841842157a978ebebdc9c503b6)faces

 const [Location](structansys_1_1dpf_1_1Location.xhtml) ansys::dpf::locations::faces  static 

Predefined faces location.





<a id="a46ac72d7066346bc309dfb44de1a20cf" name="a46ac72d7066346bc309dfb44de1a20cf"></a>## [◆ ](#a46ac72d7066346bc309dfb44de1a20cf)harmonic\_index

 const [Location](structansys_1_1dpf_1_1Location.xhtml) ansys::dpf::locations::harmonic\_index  static 

Predefined harmonic\_index location.





<a id="a0a7d57a4476a34178090d4fa96f0c550" name="a0a7d57a4476a34178090d4fa96f0c550"></a>## [◆ ](#a0a7d57a4476a34178090d4fa96f0c550)joint

 const [Location](structansys_1_1dpf_1_1Location.xhtml) ansys::dpf::locations::joint  static 

Predefined joint location.





<a id="aa4e1967b0838d8597200c606c8564d29" name="aa4e1967b0838d8597200c606c8564d29"></a>## [◆ ](#aa4e1967b0838d8597200c606c8564d29)nodal

 const [Location](structansys_1_1dpf_1_1Location.xhtml) ansys::dpf::locations::nodal  static 

Predefined nodal location.

Examples[AveragingTest.cpp](AveragingTest_8cpp-example.xhtml#a14), [DataApis.cpp](DataApis_8cpp-example.xhtml#a2), [DataExport.cpp](DataExport_8cpp-example.xhtml#a24), [OperatorsApis.cpp](OperatorsApis_8cpp-example.xhtml#a10), [ResultTest.cpp](ResultTest_8cpp-example.xhtml#a17), and [WorkflowExamples.cpp](WorkflowExamples_8cpp-example.xhtml#a9).



<a id="aba56d24e91e52e4742ee5505dff04b94" name="aba56d24e91e52e4742ee5505dff04b94"></a>## [◆ ](#aba56d24e91e52e4742ee5505dff04b94)nodal\_elemental

 const [Location](structansys_1_1dpf_1_1Location.xhtml) ansys::dpf::locations::nodal\_elemental  static 

Predefined nodal\_elemental location.





<a id="ada5a62dea9a6a1bf156f90282a273959" name="ada5a62dea9a6a1bf156f90282a273959"></a>## [◆ ](#ada5a62dea9a6a1bf156f90282a273959)overall

 const [Location](structansys_1_1dpf_1_1Location.xhtml) ansys::dpf::locations::overall  static 

Predefined overall location.





<a id="abaf9f2158d14707096139ab5eb27d70d" name="abaf9f2158d14707096139ab5eb27d70d"></a>## [◆ ](#abaf9f2158d14707096139ab5eb27d70d)phase

 const [Location](structansys_1_1dpf_1_1Location.xhtml) ansys::dpf::locations::phase  static 

Predefined phase location.





<a id="a76bdfc819d94d708b849281adf480677" name="a76bdfc819d94d708b849281adf480677"></a>## [◆ ](#a76bdfc819d94d708b849281adf480677)species

 const [Location](structansys_1_1dpf_1_1Location.xhtml) ansys::dpf::locations::species  static 

Predefined species location.





<a id="a3cf1bbc2ad6d8b8f6173e83b5118031a" name="a3cf1bbc2ad6d8b8f6173e83b5118031a"></a>## [◆ ](#a3cf1bbc2ad6d8b8f6173e83b5118031a)time\_set

 const [Location](structansys_1_1dpf_1_1Location.xhtml) ansys::dpf::locations::time\_set  static 

Predefined time\_set location.

Examples[DataApis.cpp](DataApis_8cpp-example.xhtml#a76).



<a id="abc48364ef6b184ddf696099c9a2993cd" name="abc48364ef6b184ddf696099c9a2993cd"></a>## [◆ ](#abc48364ef6b184ddf696099c9a2993cd)time\_step

 const [Location](structansys_1_1dpf_1_1Location.xhtml) ansys::dpf::locations::time\_step  static 

Predefined time\_step location.

Examples[DataApis.cpp](DataApis_8cpp-example.xhtml#a77), and [OperatorsApis.cpp](OperatorsApis_8cpp-example.xhtml#a9).



<a id="a3049c32b1dc96441810bd53803916a58" name="a3049c32b1dc96441810bd53803916a58"></a>## [◆ ](#a3049c32b1dc96441810bd53803916a58)topology

 const [Location](structansys_1_1dpf_1_1Location.xhtml) ansys::dpf::locations::topology  static 

Predefined topology location.





<a id="af0cfa3922b89f1b5be079a47a714241a" name="af0cfa3922b89f1b5be079a47a714241a"></a>## [◆ ](#af0cfa3922b89f1b5be079a47a714241a)udf\_criteria

 const [Location](structansys_1_1dpf_1_1Location.xhtml) ansys::dpf::locations::udf\_criteria  static 

Predefined udf\_criteria location.





<a id="a223dc0f57d600b9acf15ac72a603835c" name="a223dc0f57d600b9acf15ac72a603835c"></a>## [◆ ](#a223dc0f57d600b9acf15ac72a603835c)unknown

 const [Location](structansys_1_1dpf_1_1Location.xhtml) ansys::dpf::locations::unknown  static 

Predefined unknown location.





<a id="a2c1aea4cc98bb70ffb146a163121b8e4" name="a2c1aea4cc98bb70ffb146a163121b8e4"></a>## [◆ ](#a2c1aea4cc98bb70ffb146a163121b8e4)zone

 const [Location](structansys_1_1dpf_1_1Location.xhtml) ansys::dpf::locations::zone  static 

Predefined zones location.