Class ansys::dpf::Support
Last update: 25.03.2026
Define an abstract support notion.
Support describes the model. It can be the mesh, geometric entities, time or frequency domain...
Inherits from:
Inherited by:
Members
- callAPI
- deep_copy
- describe
- empty
- emptySupport
- getAsCyclicSupport
- getAsDomainMesh
- getAsTimeFreqSupport
- getAvailablePropertyNamesForFields
- getAvailablePropertyNamesForPropertyFields
- getAvailablePropertyNamesForStringFields
- getClient
- getFieldSupportByProperty
- getPropertyFieldSupportByProperty
- getStringFieldSupportByProperty
- hasBeenMovedLocally
- hasInternalObject
- isMeshedDomain
- isOnCommonAPI
- isSameObject
- operator=
- operator=
- Support
- Support
- ~DpfTypes
- ~Support
Friends
Friend Field
Friend CustomTypeField
Friend PropertyField
Friend CollectionBase
Friend Operator
Friend Workflow
Friend OperatorMain
Friend ResultInfo
Friend Any
Friend GenericDataContainer
Friend core
Public functions
Function ~Support
virtual ansys::dpf::Support::~Support()
Return type:
Function Support
ansys::dpf::Support::Support(Support const &)
Parameters:
- Support const &
Return type:
Function Support
ansys::dpf::Support::Support(Support &&) noexcept
Parameters:
- Support &&
Return type:
Function operator=
Support & ansys::dpf::Support::operator=(Support const &)
Parameters:
- Support const &
Return type: Support &
Function operator=
Support & ansys::dpf::Support::operator=(Support &&) noexcept
Parameters:
- Support &&
Return type: Support &
Function isMeshedDomain
bool ansys::dpf::Support::isMeshedDomain() const
Returns:
Indication if support is meshed domain.
Return type: bool
Function getAsDomainMesh
MeshedRegion ansys::dpf::Support::getAsDomainMesh() const
Returns:
Support as domain mesh.
Return type: MeshedRegion
Function getAsCyclicSupport
CyclicSupport ansys::dpf::Support::getAsCyclicSupport() const
Returns:
Support as cyclic support.
Return type: CyclicSupport
Function getAsTimeFreqSupport
TimeFreqSupport ansys::dpf::Support::getAsTimeFreqSupport() const
Returns:
Support as time frequency support.
Return type: TimeFreqSupport
Function getFieldSupportByProperty
Field ansys::dpf::Support::getFieldSupportByProperty(PropertyType const &property_name) const
Returns:
Field for a given property.
return empty Field if the property doesn't exist.
Parameters:
- PropertyType const & property_name
Return type: Field
Function 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.
Parameters:
- PropertyType const & property_name
Return type: PropertyField
Function 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.
Parameters:
- PropertyType const & property_name
Return type: StringField
Function getAvailablePropertyNamesForFields
std::vector< std::string > ansys::dpf::Support::getAvailablePropertyNamesForFields() const
Returns:
the list of available properties returning a Field.
Return type: std::vector< std::string >
Function getAvailablePropertyNamesForPropertyFields
std::vector< std::string > ansys::dpf::Support::getAvailablePropertyNamesForPropertyFields() const
Returns:
the list of available properties returning a PropertyField.
Return type: std::vector< std::string >
Function getAvailablePropertyNamesForStringFields
std::vector< std::string > ansys::dpf::Support::getAvailablePropertyNamesForStringFields() const
Returns:
the list of available properties returning a PropertyField.
Return type: std::vector< std::string >
Function deep_copy
Support ansys::dpf::Support::deep_copy(ansys::dpf::Client const *const client=nullptr) const
Create a new Support on a server by copying all the data of this Support.
Parameters:
- ansys::dpf::Client const *const client = nullptr : [in] Client instance designating the IP, port and protocol to use.
Return type: Support
Public static functions
Function emptySupport
static Support ansys::dpf::Support::emptySupport()
Create an empty support. Returns:
Empty Support.
Return type: Support