DPF C++ client library 2023 R2

ansys::dpf::CyclicSupport Class Reference

Last update: 10.07.2023

#include <dpf_api.h>

Inheritance diagram for ansys::dpf::CyclicSupport:
ansys::dpf::DpfTypes

Public Member Functions

 CyclicSupport (CyclicSupport const &)
 
 CyclicSupport (CyclicSupport &&)
 
CyclicSupport & operator= (CyclicSupport const &)
 
CyclicSupport & operator= (CyclicSupport &&)
 
dp_int numberOfSectors (dp_int istage=0) const
 
dp_double cyclicPhase () const
 
dp_int numberOfStages () const
 
Scoping sectorsScoping (dp_int istage=0) const
 
Scoping baseNodesScoping (dp_int istage=0) const
 
Scoping baseElementsScoping (dp_int istage=0) const
 
Scoping expandNodeIds (dp_int nodeId, Scoping sectors_scoping, dp_int istage=0) const
 
Scoping expandElementIds (dp_int elementId, Scoping sectors_scoping, dp_int istage=0) const
 
Scoping expandNodeIds (dp_int nodeId, dp_int istage=0) const
 
Scoping expandElementIds (dp_int elementId, dp_int istage=0) const
 
Field getCS () const
 
PropertyField getLowHighMap (dp_int istage=0) const
 
PropertyField getHighLowMap (dp_int istage=0) 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
 

Detailed Description

Cyclic support.

Member Function Documentation

◆ 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
[in]istageOptional stage.

◆ 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
[in]istageOptional stage.

◆ cyclicPhase()

dp_double ansys::dpf::CyclicSupport::cyclicPhase ( ) const
Returns
Cyclic phase.

◆ expandElementIds() [1/2]

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
[in]elementIdelementId to expand.
[in]istageOptional stage.

◆ expandElementIds() [2/2]

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
[in]elementIdelementId to expand.
[in]sectors_scopingScoping containing the list of sectors to expand.
[in]istageOptional stage.

◆ expandNodeIds() [1/2]

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
[in]nodeIdnodeId to expand.
[in]istageOptional stage.

◆ expandNodeIds() [2/2]

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
[in]nodeIdnodeId to expand.
[in]sectors_scopingScoping containing the list of sectors to expand.
[in]istageOptional stage.

◆ getCS()

Field ansys::dpf::CyclicSupport::getCS ( ) const
Returns
Field containing the coordinate system of the cyclic support

◆ getHighLowMap()

PropertyField ansys::dpf::CyclicSupport::getHighLowMap ( dp_int  istage = 0) const
Returns
PropertyField containing the High Low map for a stage
Parameters
[in]istageOptional stage.

◆ getLowHighMap()

PropertyField ansys::dpf::CyclicSupport::getLowHighMap ( dp_int  istage = 0) const
Returns
PropertyField containing the Low High map for a stage
Parameters
[in]istageOptional stage.

◆ numberOfSectors()

dp_int ansys::dpf::CyclicSupport::numberOfSectors ( dp_int  istage = 0) const
Returns
Number of sectors for given stage.
Parameters
[in]istageOptional stage.

◆ numberOfStages()

dp_int ansys::dpf::CyclicSupport::numberOfStages ( ) const
Returns
Number of cyclic stages

◆ 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
[in]istageOptional stage.

Connect with Ansys