Skip to main content

DPF C++ client library 2023 R2

ansys::dpf::Dimensionality Struct Reference

Last update: 10.07.2023

#include <dpf_api_base.h>

Public Types

enum  ENature {
  eScalar = 0 , eVector = 1 , eMatrix = 2 , eThirdOrderTensor = 3 ,
  eFourthOrderTensor = 4 , eSymmetricalMatrix = 5 , eDiagonalMatrix = 6 , eSymetricVoigtMatrix = 7 ,
  eIdentityMatrix = 8 , eFourthOrderIdentityTensor = 9
}
 

Public Member Functions

 Dimensionality (ENature innature, std::vector< int > const &incomponents)
 
dp_int numberOfComponents () const
 

Data Fields

std::vector< int > components
 
ENature nature
 

Detailed Description

Entity to describe the dimensionality.

See also
dimensionalities

Member Enumeration Documentation

◆ ENature

Enum value to describe handled entities dimensions.

Constructor & Destructor Documentation

◆ Dimensionality()

ansys::dpf::Dimensionality::Dimensionality ( ENature  innature,
std::vector< int > const &  incomponents 
)

Dimensionality object that describes the entity dimensions.

Parameters
[in]incomponentsENature enum value to describe the dimension of the entity.

Member Function Documentation

◆ numberOfComponents()

dp_int ansys::dpf::Dimensionality::numberOfComponents ( ) const

[in] Vector defining size of each dimension.

Returns
The number of components of the described entity.

Field Documentation

◆ components

std::vector<int> ansys::dpf::Dimensionality::components

Vector defining size of each dimension. For example, use { 1 } for scalar, { 3 } for a 3D vector, and { 3, 3 } for 3D tensor.

◆ nature

ENature ansys::dpf::Dimensionality::nature

ENature enum value to describe the dimension of the entity.