ansys::dpf::Support Class Reference
Last update: 10.07.2023
ansys::dpf::Support Class Reference
Define an abstract support notion. More...
#include <dpf_api.h>
Inheritance diagram for ansys::dpf::Support:
Public Member Functions | |
| Support (Support const &) | |
| Support (Support &&) | |
| Support & | operator= (Support const &) |
| Support & | operator= (Support &&) |
| bool | isMeshedDomain () const |
| MeshedRegion | getAsDomainMesh () const |
| CyclicSupport | getAsCyclicSupport () const |
| TimeFreqSupport | getAsTimeFreqSupport () const |
| Field | getFieldSupportByProperty (PropertyType const &property_name) const |
| PropertyField | getPropertyFieldSupportByProperty (PropertyType const &property_name) const |
| StringField | getStringFieldSupportByProperty (PropertyType const &property_name) const |
| std::vector< std::string > | getAvailablePropertyNamesForFields () const |
| std::vector< std::string > | getAvailablePropertyNamesForPropertyFields () const |
| std::vector< std::string > | getAvailablePropertyNamesForStringFields () const |
 Public Member Functions inherited from ansys::dpf::DpfTypes | |
| virtual bool | empty () const |
| virtual std::string | describe () const |
| so::API const * | callAPI () const |
| bool | isOnCommonAPI () const |
| bool | getClient (Client &client) const |
| bool | hasBeenMovedLocally () const |
| bool | isSameObject (DpfTypes const &rhs) const |
Static Public Member Functions | |
| static Support | emptySupport () |
Detailed Description
Define an abstract support notion.
Support describes the model. It can be the mesh, geometric entities, time or frequency domain...
Member Function Documentation
◆ emptySupport()
|
static |
Create an empty support.
- Returns
- Empty Support.
◆ getAsCyclicSupport()
| CyclicSupport ansys::dpf::Support::getAsCyclicSupport | ( | ) | const |
- Returns
- Support as cyclic support.
◆ getAsDomainMesh()
| MeshedRegion ansys::dpf::Support::getAsDomainMesh | ( | ) | const |
- Returns
- Support as domain mesh.
◆ getAsTimeFreqSupport()
| TimeFreqSupport ansys::dpf::Support::getAsTimeFreqSupport | ( | ) | const |
- Returns
- Support as time frequency support.
◆ getAvailablePropertyNamesForFields()
| std::vector< std::string > ansys::dpf::Support::getAvailablePropertyNamesForFields | ( | ) | const |
- Returns
- the list of available properties returning a Field.
◆ getAvailablePropertyNamesForPropertyFields()
| std::vector< std::string > ansys::dpf::Support::getAvailablePropertyNamesForPropertyFields | ( | ) | const |
- Returns
- the list of available properties returning a PropertyField.
◆ getAvailablePropertyNamesForStringFields()
| std::vector< std::string > ansys::dpf::Support::getAvailablePropertyNamesForStringFields | ( | ) | const |
- Returns
- the list of available properties returning a PropertyField.
◆ getFieldSupportByProperty()
| Field ansys::dpf::Support::getFieldSupportByProperty | ( | PropertyType const & | property_name | ) | const |
◆ getPropertyFieldSupportByProperty()
| PropertyField ansys::dpf::Support::getPropertyFieldSupportByProperty | ( | PropertyType const & | property_name | ) | const |
- Returns
- PropertyField for a given property.
return empty PropertyField if the property doesn't exist.
◆ getStringFieldSupportByProperty()
| StringField ansys::dpf::Support::getStringFieldSupportByProperty | ( | PropertyType const & | property_name | ) | const |
- Returns
- StringField for a given property.
return empty StringField if the property doesn't exist.
◆ isMeshedDomain()
| bool ansys::dpf::Support::isMeshedDomain | ( | ) | const |
- Returns
- Indication if support is meshed domain.