## On this page

  

 

 # ansys::dpf::Support Class Reference

 Last update: 16.07.2025 

Define an abstract support notion. [More...](classansys_1_1dpf_1_1Support.xhtml#details)

`#include <dpf_api.h>`

Inheritance diagram for ansys::dpf::Support:

 ![](/sites/default/files/migrate-content/dpf_cpp_client_library_2023_r2/classansys_1_1dpf_1_1Support.png)



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

<a id="a7437ca78d2d2fa368dc0063fdf3c221a" name="a7437ca78d2d2fa368dc0063fdf3c221a"></a> **Support** ([Support](classansys_1_1dpf_1_1Support.xhtml) const &amp;) <a id="ae893477377fb6dfd08be315b7e381304" name="ae893477377fb6dfd08be315b7e381304"></a> **Support** ([Support](classansys_1_1dpf_1_1Support.xhtml) &amp;&amp;) <a id="aafaebcbcdc49b2ab6fe730399f382d81" name="aafaebcbcdc49b2ab6fe730399f382d81"></a>[Support](classansys_1_1dpf_1_1Support.xhtml) &amp; **operator=** ([Support](classansys_1_1dpf_1_1Support.xhtml) const &amp;) <a id="aaf08fa22f211ed32c949b45a0d81d3be" name="aaf08fa22f211ed32c949b45a0d81d3be"></a>[Support](classansys_1_1dpf_1_1Support.xhtml) &amp; **operator=** ([Support](classansys_1_1dpf_1_1Support.xhtml) &amp;&amp;) bool [isMeshedDomain](classansys_1_1dpf_1_1Support.xhtml#a3cad097e6d82306d5ab8ba23bdb7c8ff) () const [MeshedRegion](classansys_1_1dpf_1_1MeshedRegion.xhtml) [getAsDomainMesh](classansys_1_1dpf_1_1Support.xhtml#a244cc29be85eb6192faf468268478064) () const [CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) [getAsCyclicSupport](classansys_1_1dpf_1_1Support.xhtml#a5903cf9eb1f3f3fec9fc0a22331db3d3) () const [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml) [getAsTimeFreqSupport](classansys_1_1dpf_1_1Support.xhtml#a2ced0ad4403332166b14f301d67f4a4e) () const [Field](classansys_1_1dpf_1_1Field.xhtml) [getFieldSupportByProperty](classansys_1_1dpf_1_1Support.xhtml#aa4704f682e0e0543acf44e37e9350aab) ([PropertyType](structansys_1_1dpf_1_1PropertyType.xhtml) const &amp;property\_name) const [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) [getPropertyFieldSupportByProperty](classansys_1_1dpf_1_1Support.xhtml#a7b80b961c6418d9c54bb2d50560d3d2f) ([PropertyType](structansys_1_1dpf_1_1PropertyType.xhtml) const &amp;property\_name) const [StringField](classansys_1_1dpf_1_1StringField.xhtml) [getStringFieldSupportByProperty](classansys_1_1dpf_1_1Support.xhtml#a85465ef9621478e6990fddc5ecddc264) ([PropertyType](structansys_1_1dpf_1_1PropertyType.xhtml) const &amp;property\_name) const std::vector&lt; std::string &gt; [getAvailablePropertyNamesForFields](classansys_1_1dpf_1_1Support.xhtml#ac6c5332826a5eb2814e71a02fe3e7132) () const std::vector&lt; std::string &gt; [getAvailablePropertyNamesForPropertyFields](classansys_1_1dpf_1_1Support.xhtml#adb40c35236879d4d6d8a418c618a2f00) () const std::vector&lt; std::string &gt; [getAvailablePropertyNamesForStringFields](classansys_1_1dpf_1_1Support.xhtml#aefed9b020ce057f1c59e87c5cd0c11f5) () const ![-](/sites/default/files/migrate-content/dpf_cpp_client_library_2023_r2/closed.png) Public Member Functions inherited from [ansys::dpf::DpfTypes](classansys_1_1dpf_1_1DpfTypes.xhtml)virtual bool [empty](classansys_1_1dpf_1_1DpfTypes.xhtml#a39cd546c42518e2332be8f287db95459) () const virtual std::string [describe](classansys_1_1dpf_1_1DpfTypes.xhtml#a9977945710983bc03d2940fa007847b2) () const so::API const \* [callAPI](classansys_1_1dpf_1_1DpfTypes.xhtml#aea34d37e0c080126eff70db34bf46597) () const bool [isOnCommonAPI](classansys_1_1dpf_1_1DpfTypes.xhtml#a9f9789ff61cc9d400a2a344830706b73) () const bool [getClient](classansys_1_1dpf_1_1DpfTypes.xhtml#a968afd9daa0b0f13b65a2ac61369d73a) ([Client](classansys_1_1dpf_1_1Client.xhtml) &amp;client) const bool [hasBeenMovedLocally](classansys_1_1dpf_1_1DpfTypes.xhtml#a1a5634202c15404b6b24e8f50e51cb66) () const bool [isSameObject](classansys_1_1dpf_1_1DpfTypes.xhtml#aa64d5f8fcd7d85ad6ebf708494dbefd7) ([DpfTypes](classansys_1_1dpf_1_1DpfTypes.xhtml) const &amp;rhs) const ## <a id="pub-static-methods" name="pub-static-methods"></a>Static Public Member Functions

static [Support](classansys_1_1dpf_1_1Support.xhtml) [emptySupport](classansys_1_1dpf_1_1Support.xhtml#ad5b62f0bc3fc29380461006280edf89b) () <a id="details" name="details"></a>## Detailed Description

Define an abstract support notion.

[Support](classansys_1_1dpf_1_1Support.xhtml) describes the model. It can be the mesh, geometric entities, time or frequency domain...



## Member Function Documentation

<a id="ad5b62f0bc3fc29380461006280edf89b" name="ad5b62f0bc3fc29380461006280edf89b"></a>## [◆ ](#ad5b62f0bc3fc29380461006280edf89b)emptySupport()

 static [Support](classansys_1_1dpf_1_1Support.xhtml) ansys::dpf::Support::emptySupport  ( )   static 

Create an empty support.

ReturnsEmpty [Support](classansys_1_1dpf_1_1Support.xhtml). 



<a id="a5903cf9eb1f3f3fec9fc0a22331db3d3" name="a5903cf9eb1f3f3fec9fc0a22331db3d3"></a>## [◆ ](#a5903cf9eb1f3f3fec9fc0a22331db3d3)getAsCyclicSupport()

 [CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) ansys::dpf::Support::getAsCyclicSupport  ( )  const

Returns[Support](classansys_1_1dpf_1_1Support.xhtml) as cyclic support. 



<a id="a244cc29be85eb6192faf468268478064" name="a244cc29be85eb6192faf468268478064"></a>## [◆ ](#a244cc29be85eb6192faf468268478064)getAsDomainMesh()

 [MeshedRegion](classansys_1_1dpf_1_1MeshedRegion.xhtml) ansys::dpf::Support::getAsDomainMesh  ( )  const

Returns[Support](classansys_1_1dpf_1_1Support.xhtml) as domain mesh. 



<a id="a2ced0ad4403332166b14f301d67f4a4e" name="a2ced0ad4403332166b14f301d67f4a4e"></a>## [◆ ](#a2ced0ad4403332166b14f301d67f4a4e)getAsTimeFreqSupport()

 [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml) ansys::dpf::Support::getAsTimeFreqSupport  ( )  const

Returns[Support](classansys_1_1dpf_1_1Support.xhtml) as time frequency support. 



<a id="ac6c5332826a5eb2814e71a02fe3e7132" name="ac6c5332826a5eb2814e71a02fe3e7132"></a>## [◆ ](#ac6c5332826a5eb2814e71a02fe3e7132)getAvailablePropertyNamesForFields()

 std::vector&lt; std::string &gt; ansys::dpf::Support::getAvailablePropertyNamesForFields  ( )  const

Returnsthe list of available properties returning a [Field](classansys_1_1dpf_1_1Field.xhtml). 



<a id="adb40c35236879d4d6d8a418c618a2f00" name="adb40c35236879d4d6d8a418c618a2f00"></a>## [◆ ](#adb40c35236879d4d6d8a418c618a2f00)getAvailablePropertyNamesForPropertyFields()

 std::vector&lt; std::string &gt; ansys::dpf::Support::getAvailablePropertyNamesForPropertyFields  ( )  const

Returnsthe list of available properties returning a [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml). 



<a id="aefed9b020ce057f1c59e87c5cd0c11f5" name="aefed9b020ce057f1c59e87c5cd0c11f5"></a>## [◆ ](#aefed9b020ce057f1c59e87c5cd0c11f5)getAvailablePropertyNamesForStringFields()

 std::vector&lt; std::string &gt; ansys::dpf::Support::getAvailablePropertyNamesForStringFields  ( )  const

Returnsthe list of available properties returning a [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml). 



<a id="aa4704f682e0e0543acf44e37e9350aab" name="aa4704f682e0e0543acf44e37e9350aab"></a>## [◆ ](#aa4704f682e0e0543acf44e37e9350aab)getFieldSupportByProperty()

 [Field](classansys_1_1dpf_1_1Field.xhtml) ansys::dpf::Support::getFieldSupportByProperty  ( [PropertyType](structansys_1_1dpf_1_1PropertyType.xhtml) const &amp;  *property\_name*)  const

Returns[Field](classansys_1_1dpf_1_1Field.xhtml) for a given property.return empty [Field](classansys_1_1dpf_1_1Field.xhtml "Data for an entity.") if the property doesn't exist.





<a id="a7b80b961c6418d9c54bb2d50560d3d2f" name="a7b80b961c6418d9c54bb2d50560d3d2f"></a>## [◆ ](#a7b80b961c6418d9c54bb2d50560d3d2f)getPropertyFieldSupportByProperty()

 [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) ansys::dpf::Support::getPropertyFieldSupportByProperty  ( [PropertyType](structansys_1_1dpf_1_1PropertyType.xhtml) const &amp;  *property\_name*)  const

Returns[PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) for a given property.return empty [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) if the property doesn't exist.





<a id="a85465ef9621478e6990fddc5ecddc264" name="a85465ef9621478e6990fddc5ecddc264"></a>## [◆ ](#a85465ef9621478e6990fddc5ecddc264)getStringFieldSupportByProperty()

 [StringField](classansys_1_1dpf_1_1StringField.xhtml) ansys::dpf::Support::getStringFieldSupportByProperty  ( [PropertyType](structansys_1_1dpf_1_1PropertyType.xhtml) const &amp;  *property\_name*)  const

Returns[StringField](classansys_1_1dpf_1_1StringField.xhtml) for a given property.return empty [StringField](classansys_1_1dpf_1_1StringField.xhtml) if the property doesn't exist.





<a id="a3cad097e6d82306d5ab8ba23bdb7c8ff" name="a3cad097e6d82306d5ab8ba23bdb7c8ff"></a>## [◆ ](#a3cad097e6d82306d5ab8ba23bdb7c8ff)isMeshedDomain()

 bool ansys::dpf::Support::isMeshedDomain  ( )  const

ReturnsIndication if support is meshed domain.