Class ansys::dpf::CyclicSupport
Last update: 25.03.2026
Cyclic support.
Inherits from:
Members
- baseElementsScoping
- baseNodesScoping
- callAPI
- cyclicPhase
- CyclicSupport
- CyclicSupport
- describe
- empty
- expandElementIds
- expandElementIds
- expandNodeIds
- expandNodeIds
- getClient
- getCS
- getHighLowMap
- getLowHighMap
- hasBeenMovedLocally
- hasInternalObject
- isOnCommonAPI
- isSameObject
- numberOfSectors
- numberOfStages
- operator=
- operator=
- sectorsScoping
- ~CyclicSupport
- ~DpfTypes
Friends
Public functions
Function ~CyclicSupport
virtual ansys::dpf::CyclicSupport::~CyclicSupport()
Return type:
Function CyclicSupport
ansys::dpf::CyclicSupport::CyclicSupport(CyclicSupport const &)
Parameters:
- CyclicSupport const &
Return type:
Function CyclicSupport
ansys::dpf::CyclicSupport::CyclicSupport(CyclicSupport &&) noexcept
Parameters:
- CyclicSupport &&
Return type:
Function operator=
CyclicSupport & ansys::dpf::CyclicSupport::operator=(CyclicSupport const &)
Parameters:
- CyclicSupport const &
Return type: CyclicSupport &
Function operator=
CyclicSupport & ansys::dpf::CyclicSupport::operator=(CyclicSupport &&) noexcept
Parameters:
- CyclicSupport &&
Return type: CyclicSupport &
Function numberOfSectors
dp_int ansys::dpf::CyclicSupport::numberOfSectors(dp_int istage=0) const
Returns:
Number of sectors for given stage.
Parameters:
- dp_int istage = 0 : [in] Optional stage.
Return type: dp_int
Function cyclicPhase
dp_double ansys::dpf::CyclicSupport::cyclicPhase() const
Returns:
Cyclic phase.
Return type: dp_double
Function numberOfStages
dp_int ansys::dpf::CyclicSupport::numberOfStages() const
Returns:
Number of cyclic stages
Return type: dp_int
Function sectorsScoping
Scoping ansys::dpf::CyclicSupport::sectorsScoping(dp_int istage=0) const
Returns:
Scoping containing the list of sectors that are currently set for expansion for given stage.
Parameters:
- dp_int istage = 0 : [in] Optional stage.
Return type: Scoping
Function baseNodesScoping
Scoping ansys::dpf::CyclicSupport::baseNodesScoping(dp_int istage=0) const
Returns:
Scoping containing the node ids in the base sector for given stage.
Parameters:
- dp_int istage = 0 : [in] Optional stage.
Return type: Scoping
Function baseElementsScoping
Scoping ansys::dpf::CyclicSupport::baseElementsScoping(dp_int istage=0) const
Returns:
Scoping containing the element ids in the base sector for given stage.
Parameters:
- dp_int istage = 0 : [in] Optional stage.
Return type: Scoping
Function expandNodeIds
Scoping ansys::dpf::CyclicSupport::expandNodeIds(dp_int nodeId, Scoping sectors_scoping, dp_int istage=0) const
Returns:
Scoping containing the nodes ids corresponding to the base nodeId given in input for the expanded sectors given in sectorsScoping
Parameters:
- dp_int nodeId: [in] nodeId to expand.
- Scoping sectors_scoping: [in] Scoping containing the list of sectors to expand.
- dp_int istage = 0 : [in] Optional stage.
Return type: Scoping
Function expandElementIds
Scoping ansys::dpf::CyclicSupport::expandElementIds(dp_int elementId, Scoping sectors_scoping, dp_int istage=0) const
Returns:
Scoping containing the element ids corresponding to the base elementId given in input for the expanded sectors given in sectorsScoping
Parameters:
- dp_int elementId: [in] elementId to expand.
- Scoping sectors_scoping: [in] Scoping containing the list of sectors to expand.
- dp_int istage = 0 : [in] Optional stage.
Return type: Scoping
Function expandNodeIds
Scoping ansys::dpf::CyclicSupport::expandNodeIds(dp_int nodeId, dp_int istage=0) const
Returns:
Scoping containing the nodes ids corresponding to the base nodeId given in input for all expanded sectors
Parameters:
Return type: Scoping
Function expandElementIds
Scoping ansys::dpf::CyclicSupport::expandElementIds(dp_int elementId, dp_int istage=0) const
Returns:
Scoping containing the element ids corresponding to the base elementId given in input for all expanded sectors
Parameters:
Return type: Scoping
Function getCS
Field ansys::dpf::CyclicSupport::getCS() const
Returns:
Field containing the coordinate system of the cyclic support
Return type: Field
Function getLowHighMap
PropertyField ansys::dpf::CyclicSupport::getLowHighMap(dp_int istage=0) const
Returns:
PropertyField containing the Low High map for a stage
Parameters:
- dp_int istage = 0 : [in] Optional stage.
Return type: PropertyField
Function getHighLowMap
PropertyField ansys::dpf::CyclicSupport::getHighLowMap(dp_int istage=0) const
Returns:
PropertyField containing the High Low map for a stage
Parameters:
- dp_int istage = 0 : [in] Optional stage.
Return type: PropertyField