## On this page

  

 

 # ansys::dpf::CyclicSupport Class Reference

 Last update: 16.07.2025 

`#include <dpf_api.h>`

Inheritance diagram for ansys::dpf::CyclicSupport:

 ![](/sites/default/files/migrate-content/dpf_cpp_client_library_2024_r1/classansys_1_1dpf_1_1CyclicSupport.png)



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

<a id="a167515c0ac6b88691bb7e4ececb0b681" name="a167515c0ac6b88691bb7e4ececb0b681"></a> **CyclicSupport** ([CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) const &amp;) <a id="a28f54ee1142d3dc2fd4e4fc01ae95f10" name="a28f54ee1142d3dc2fd4e4fc01ae95f10"></a> **CyclicSupport** ([CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) &amp;&amp;) <a id="af76b9abf1c80035b8cd5899713e033e5" name="af76b9abf1c80035b8cd5899713e033e5"></a>[CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) &amp; **operator=** ([CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) const &amp;) <a id="ac4a98ce6f210b03b6b62a11a9336394d" name="ac4a98ce6f210b03b6b62a11a9336394d"></a>[CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) &amp; **operator=** ([CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) &amp;&amp;) [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) [numberOfSectors](classansys_1_1dpf_1_1CyclicSupport.xhtml#a1f0072201719869dfda1a6c37a28d275) ([dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) istage=0) const [dp\_double](namespaceansys_1_1dpf.xhtml#acb480013bfed185b5e34a0bdcb0e3790) [cyclicPhase](classansys_1_1dpf_1_1CyclicSupport.xhtml#aeaa227de7fafa2eb64aab9732a04d80b) () const [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) [numberOfStages](classansys_1_1dpf_1_1CyclicSupport.xhtml#af834b226d2a2bd4bcfcf458d37a923a8) () const [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) [sectorsScoping](classansys_1_1dpf_1_1CyclicSupport.xhtml#ad561eac9c58fa4e34e61504b929965c7) ([dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) istage=0) const [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) [baseNodesScoping](classansys_1_1dpf_1_1CyclicSupport.xhtml#a289185098318b67131eac363e87a8b1c) ([dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) istage=0) const [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) [baseElementsScoping](classansys_1_1dpf_1_1CyclicSupport.xhtml#afe466d1bf1bced2f13d6796c1dbf8d43) ([dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) istage=0) const [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) [expandNodeIds](classansys_1_1dpf_1_1CyclicSupport.xhtml#a424ecf4652277b14097d88efaa2357ce) ([dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) nodeId, [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) sectors\_scoping, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) istage=0) const [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) [expandElementIds](classansys_1_1dpf_1_1CyclicSupport.xhtml#ac82ffdc8ee8757bc89c4d718df1d1e9a) ([dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) elementId, [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) sectors\_scoping, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) istage=0) const [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) [expandNodeIds](classansys_1_1dpf_1_1CyclicSupport.xhtml#a919b31109b428b4c1b01d0250692b2d2) ([dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) nodeId, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) istage=0) const [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) [expandElementIds](classansys_1_1dpf_1_1CyclicSupport.xhtml#a433d08a3b3ee58bac68d03eced3ecfb2) ([dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) elementId, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) istage=0) const [Field](classansys_1_1dpf_1_1Field.xhtml) [getCS](classansys_1_1dpf_1_1CyclicSupport.xhtml#aaf1374d17a058f6de2819f705cea9af0) () const [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) [getLowHighMap](classansys_1_1dpf_1_1CyclicSupport.xhtml#a84a78c2f95c129e8332e55560318f228) ([dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) istage=0) const [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) [getHighLowMap](classansys_1_1dpf_1_1CyclicSupport.xhtml#aa72ada08e8cd4534621bd2cf1a20577c) ([dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) istage=0) const ![-](/sites/default/files/migrate-content/dpf_cpp_client_library_2024_r1/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 bool [hasInternalObject](classansys_1_1dpf_1_1DpfTypes.xhtml#ae198f89868d85c7db6dc1a934a1d3c15) () 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="details" name="details"></a>## Detailed Description

Cyclic support.



## Member Function Documentation

<a id="afe466d1bf1bced2f13d6796c1dbf8d43" name="afe466d1bf1bced2f13d6796c1dbf8d43"></a>## [◆ ](#afe466d1bf1bced2f13d6796c1dbf8d43)baseElementsScoping()

 [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) ansys::dpf::CyclicSupport::baseElementsScoping  ( [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *istage* = `0`)  const

Returns[Scoping](classansys_1_1dpf_1_1Scoping.xhtml) containing the element ids in the base sector for given stage. Parameters \[in\]istageOptional stage. 



<a id="a289185098318b67131eac363e87a8b1c" name="a289185098318b67131eac363e87a8b1c"></a>## [◆ ](#a289185098318b67131eac363e87a8b1c)baseNodesScoping()

 [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) ansys::dpf::CyclicSupport::baseNodesScoping  ( [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *istage* = `0`)  const

Returns[Scoping](classansys_1_1dpf_1_1Scoping.xhtml) containing the node ids in the base sector for given stage. Parameters \[in\]istageOptional stage. 



<a id="aeaa227de7fafa2eb64aab9732a04d80b" name="aeaa227de7fafa2eb64aab9732a04d80b"></a>## [◆ ](#aeaa227de7fafa2eb64aab9732a04d80b)cyclicPhase()

 [dp\_double](namespaceansys_1_1dpf.xhtml#acb480013bfed185b5e34a0bdcb0e3790) ansys::dpf::CyclicSupport::cyclicPhase  ( )  const

ReturnsCyclic phase. 



<a id="a433d08a3b3ee58bac68d03eced3ecfb2" name="a433d08a3b3ee58bac68d03eced3ecfb2"></a>## [◆ ](#a433d08a3b3ee58bac68d03eced3ecfb2)expandElementIds() \[1/2\]

 [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) ansys::dpf::CyclicSupport::expandElementIds  ( [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *elementId*,    [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *istage* = `0`   )  const

Returns[Scoping](classansys_1_1dpf_1_1Scoping.xhtml) containing the element ids corresponding to the base elementId given in input for all expanded sectors Parameters \[in\]elementIdelementId to expand. \[in\]istageOptional stage. 



<a id="ac82ffdc8ee8757bc89c4d718df1d1e9a" name="ac82ffdc8ee8757bc89c4d718df1d1e9a"></a>## [◆ ](#ac82ffdc8ee8757bc89c4d718df1d1e9a)expandElementIds() \[2/2\]

 [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) ansys::dpf::CyclicSupport::expandElementIds  ( [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *elementId*,    [Scoping](classansys_1_1dpf_1_1Scoping.xhtml)  *sectors\_scoping*,    [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *istage* = `0`   )  const

Returns[Scoping](classansys_1_1dpf_1_1Scoping.xhtml) containing the element ids corresponding to the base elementId given in input for the expanded sectors given in sectorsScoping Parameters \[in\]elementIdelementId to expand. \[in\]sectors\_scoping[Scoping](classansys_1_1dpf_1_1Scoping.xhtml "Define a set of entities by ids.") containing the list of sectors to expand. \[in\]istageOptional stage. 



<a id="a919b31109b428b4c1b01d0250692b2d2" name="a919b31109b428b4c1b01d0250692b2d2"></a>## [◆ ](#a919b31109b428b4c1b01d0250692b2d2)expandNodeIds() \[1/2\]

 [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) ansys::dpf::CyclicSupport::expandNodeIds  ( [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *nodeId*,    [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *istage* = `0`   )  const

Returns[Scoping](classansys_1_1dpf_1_1Scoping.xhtml) containing the nodes ids corresponding to the base nodeId given in input for all expanded sectors Parameters \[in\]nodeIdnodeId to expand. \[in\]istageOptional stage. 



<a id="a424ecf4652277b14097d88efaa2357ce" name="a424ecf4652277b14097d88efaa2357ce"></a>## [◆ ](#a424ecf4652277b14097d88efaa2357ce)expandNodeIds() \[2/2\]

 [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) ansys::dpf::CyclicSupport::expandNodeIds  ( [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *nodeId*,    [Scoping](classansys_1_1dpf_1_1Scoping.xhtml)  *sectors\_scoping*,    [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *istage* = `0`   )  const

Returns[Scoping](classansys_1_1dpf_1_1Scoping.xhtml) containing the nodes ids corresponding to the base nodeId given in input for the expanded sectors given in sectorsScoping Parameters \[in\]nodeIdnodeId to expand. \[in\]sectors\_scoping[Scoping](classansys_1_1dpf_1_1Scoping.xhtml "Define a set of entities by ids.") containing the list of sectors to expand. \[in\]istageOptional stage. 



<a id="aaf1374d17a058f6de2819f705cea9af0" name="aaf1374d17a058f6de2819f705cea9af0"></a>## [◆ ](#aaf1374d17a058f6de2819f705cea9af0)getCS()

 [Field](classansys_1_1dpf_1_1Field.xhtml) ansys::dpf::CyclicSupport::getCS  ( )  const

Returns[Field](classansys_1_1dpf_1_1Field.xhtml) containing the coordinate system of the cyclic support 



<a id="aa72ada08e8cd4534621bd2cf1a20577c" name="aa72ada08e8cd4534621bd2cf1a20577c"></a>## [◆ ](#aa72ada08e8cd4534621bd2cf1a20577c)getHighLowMap()

 [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) ansys::dpf::CyclicSupport::getHighLowMap  ( [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *istage* = `0`)  const

Returns[PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) containing the High Low map for a stage Parameters \[in\]istageOptional stage. 



<a id="a84a78c2f95c129e8332e55560318f228" name="a84a78c2f95c129e8332e55560318f228"></a>## [◆ ](#a84a78c2f95c129e8332e55560318f228)getLowHighMap()

 [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) ansys::dpf::CyclicSupport::getLowHighMap  ( [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *istage* = `0`)  const

Returns[PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) containing the Low High map for a stage Parameters \[in\]istageOptional stage. 



<a id="a1f0072201719869dfda1a6c37a28d275" name="a1f0072201719869dfda1a6c37a28d275"></a>## [◆ ](#a1f0072201719869dfda1a6c37a28d275)numberOfSectors()

 [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) ansys::dpf::CyclicSupport::numberOfSectors  ( [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *istage* = `0`)  const

ReturnsNumber of sectors for given stage. Parameters \[in\]istageOptional stage. 



<a id="af834b226d2a2bd4bcfcf458d37a923a8" name="af834b226d2a2bd4bcfcf458d37a923a8"></a>## [◆ ](#af834b226d2a2bd4bcfcf458d37a923a8)numberOfStages()

 [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) ansys::dpf::CyclicSupport::numberOfStages  ( )  const

ReturnsNumber of cyclic stages 



<a id="ad561eac9c58fa4e34e61504b929965c7" name="ad561eac9c58fa4e34e61504b929965c7"></a>## [◆ ](#ad561eac9c58fa4e34e61504b929965c7)sectorsScoping()

 [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) ansys::dpf::CyclicSupport::sectorsScoping  ( [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *istage* = `0`)  const

Returns[Scoping](classansys_1_1dpf_1_1Scoping.xhtml) containing the list of sectors that are currently set for expansion for given stage. Parameters \[in\]istageOptional stage.