DATAKIT SDK  V2026.2
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
Dtk_PhysicalMaterialInfos Class Referenceabstract
+ Inheritance diagram for Dtk_PhysicalMaterialInfos:

Public Types

enum  MaterialSymetryType { UnknownType = 0, Isotropic = 1, IsotropeTrans = 2, Orthotrope = 3 }
 

Public Member Functions

Dtk_Int32 DtkDynamicType (const Dtk_Int32 &inId)
 Retrieves the dynamic entity type. More...
 
virtual int DtkDynamicType (const int &inId)=0
 
virtual void dump (FILE *file=stdout)
 
Dtk_tab< Dtk_MetaDataPtr > const & GetCustomData ()
 Returns the material custom data. More...
 
Dtk_ErrorStatus GetDensity (Dtk_Double64 &outValue, Dtk_string &outUnits) const
 Returns the material density. More...
 
Dtk_ErrorStatus GetHardeningRatio (Dtk_Double64 ouHardeningRatio[3]) const
 Returns the material hardening ratio. More...
 
Dtk_string GetName () const
 Returns the material name. More...
 
Dtk_ErrorStatus GetPoissonRatio (Dtk_Double64 outPoissonRatio[3]) const
 Returns the material poisson ratio. More...
 
Dtk_ErrorStatus GetShearModulus (Dtk_Double64 outShearModulus[3], Dtk_string &outUnits) const
 Returns the material shear modulus. More...
 
virtual Dtk_Size_t GetSize () const
 
Dtk_ErrorStatus GetSpecificHeat (Dtk_Double64 &outValue, Dtk_string &outUnits) const
 Returns the material specific heat. More...
 
Dtk_ErrorStatus GetTensileStrength (Dtk_Double64 &outValue, Dtk_string &outUnits) const
 Returns the material tensile strength. More...
 
Dtk_ErrorStatus GetThermalConductivity (Dtk_Double64 &outValue, Dtk_string &outUnits) const
 Returns the material thermal conductivity. More...
 
Dtk_ErrorStatus GetThermalExpansion (Dtk_Double64 &outValue, Dtk_string &outUnits) const
 Returns the material thermal expansion. More...
 
MaterialSymetryType GetType () const
 Returns the material type. More...
 
Dtk_string GetTypeAsString () const
 Returns the material type as a Dtk_string. More...
 
Dtk_ErrorStatus GetYieldStrength (Dtk_Double64 &outValue, Dtk_string &outUnits) const
 Returns the material yield strength. More...
 
Dtk_ErrorStatus GetYoungModulus (Dtk_Double64 outYoungModulus[3], Dtk_string &outUnits) const
 Returns the material young modulus. More...
 
Dtk_ErrorStatus SetCustomData (Dtk_tab< Dtk_MetaDataPtr > inCustomData)
 Sets the material custom data. More...
 
Dtk_ErrorStatus SetDensity (Dtk_Double64 inValue, Dtk_string inUnits)
 Sets the material density. More...
 
Dtk_ErrorStatus SetHardeningRatio (Dtk_Double64 inHardeningRatio[3])
 Sets the material hardening ratio. More...
 
Dtk_ErrorStatus SetName (Dtk_string inName)
 Sets the material name. More...
 
Dtk_ErrorStatus SetPoissonRatio (Dtk_Double64 inPoissonRatio[3])
 Sets the material poisson ratio. More...
 
Dtk_ErrorStatus SetShearModulus (Dtk_Double64 inShearModulus[3], Dtk_string inUnits)
 Sets the material shear modulus. More...
 
Dtk_ErrorStatus SetSpecificHeat (Dtk_Double64 inValue, Dtk_string inUnits)
 Sets the material specific heat. More...
 
Dtk_ErrorStatus SetTensileStrength (Dtk_Double64 inValue, Dtk_string inUnits)
 Sets the material tensile strength. More...
 
Dtk_ErrorStatus SetThermalConductivity (Dtk_Double64 inValue, Dtk_string inUnits)
 Sets the material thermal conductivity. More...
 
Dtk_ErrorStatus SetThermalExpansion (Dtk_Double64 inValue, Dtk_string inUnits)
 Sets the material thermal expansion. More...
 
Dtk_ErrorStatus SetType (MaterialSymetryType inType)
 Sets the material type. More...
 
Dtk_ErrorStatus SetYieldStrength (Dtk_Double64 inValue, Dtk_string inUnits)
 Sets the material yield strength. More...
 
Dtk_ErrorStatus SetYoungModulus (Dtk_Double64 inYoungModulus[3], Dtk_string inUnits)
 Sets the material young modulus. More...
 

Static Public Member Functions

static Dtk_PhysicalMaterialInfosPtr Create (const Dtk_PhysicalMaterialInfos &in)
 Calls copy constructor to allocate a new object. More...
 
static Dtk_PhysicalMaterialInfosPtr Create (Dtk_string inName, MaterialSymetryType inType)
 Creates a Dtk_MaterialInfosPtr. More...
 
static Dtk_PhysicalMaterialInfos * DtkDynamicCast (Dtk_Object *s)
 Performs a dynamic cast - doesn't need RTTI -. More...
 

Protected Types

enum  { _typeID = DTK_TYPE_OBJECT }
 
enum  { _typeID = DTK_TYPE_MATERIAL_INFOS }
 

Protected Member Functions

virtual Dtk_Object * Clone ()
 
 Dtk_PhysicalMaterialInfos (const Dtk_PhysicalMaterialInfos &inToBeCopied)
 \Copy Constructor{inToBeCopied} More...
 
 Dtk_PhysicalMaterialInfos (Dtk_string inName, MaterialSymetryType inType)
 
virtual ~Dtk_PhysicalMaterialInfos ()
 Destructor. More...
 

Protected Attributes

Dtk_Handle * _Private
 
unsigned long count_
 

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
_typeID 
10 { _typeID = DTK_TYPE_OBJECT };

◆ anonymous enum

anonymous enum
protected
Enumerator
_typeID 
402 { _typeID = DTK_TYPE_MATERIAL_INFOS };

◆ MaterialSymetryType

enum Dtk_PhysicalMaterialInfos::MaterialSymetryType
Enumerator
UnknownType 
Isotropic 
IsotropeTrans 
Orthotrope 
394  {
395  UnknownType = 0,
396  Isotropic = 1,
397  IsotropeTrans = 2,
398  Orthotrope = 3
399  };

Constructor & Destructor Documentation

◆ Dtk_PhysicalMaterialInfos() [1/2]

Dtk_PhysicalMaterialInfos::Dtk_PhysicalMaterialInfos ( const Dtk_PhysicalMaterialInfos &  inToBeCopied)
protected

\Copy Constructor{inToBeCopied}

◆ Dtk_PhysicalMaterialInfos() [2/2]

Dtk_PhysicalMaterialInfos::Dtk_PhysicalMaterialInfos ( Dtk_string  inName,
MaterialSymetryType  inType 
)
protected
See also
Create Dtk_PhysicalMaterialInfos

◆ ~Dtk_PhysicalMaterialInfos()

virtual Dtk_PhysicalMaterialInfos::~Dtk_PhysicalMaterialInfos ( )
protectedvirtual

Destructor.

Member Function Documentation

◆ Clone()

virtual Dtk_Object* Dtk_PhysicalMaterialInfos::Clone ( )
protectedvirtual
416 { return new Dtk_PhysicalMaterialInfos(*this); }

◆ Create() [1/2]

static Dtk_PhysicalMaterialInfosPtr Dtk_PhysicalMaterialInfos::Create ( const Dtk_PhysicalMaterialInfos &  in)
static

Calls copy constructor to allocate a new object.

Parameters
inObject to copy from.

◆ Create() [2/2]

static Dtk_PhysicalMaterialInfosPtr Dtk_PhysicalMaterialInfos::Create ( Dtk_string  inName,
MaterialSymetryType  inType 
)
static

Creates a Dtk_MaterialInfosPtr.

Parameters
[in]inNamethe desired name for the material.
[in]inTypethe desired type for the material.
Returns
the constructed Dtk_MaterialInfosPtr.

◆ DtkDynamicCast()

static Dtk_PhysicalMaterialInfos* Dtk_PhysicalMaterialInfos::DtkDynamicCast ( Dtk_Object *  s)
static

Performs a dynamic cast - doesn't need RTTI -.

439  {
440  if (s->DtkDynamicType(_typeID)) return static_cast<Dtk_PhysicalMaterialInfos*>(s);
441  return NULL;
442  }

◆ DtkDynamicType() [1/2]

Dtk_Int32 Dtk_PhysicalMaterialInfos::DtkDynamicType ( const Dtk_Int32 &  inId)

Retrieves the dynamic entity type.

432  {
433  if (inId == _typeID) return 1;
434  return Dtk_Object::DtkDynamicType(inId);
435  }

◆ DtkDynamicType() [2/2]

virtual int Dtk_Object::DtkDynamicType ( const int &  inId)
pure virtualinherited

Implemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_TopologicalEntity, Dtk_MeshPolyline, Dtk_MeshSurface, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, Dtk_Point, Dtk_Constraint, Dtk_ConstraintReference, Dtk_AxisSystem, Dtk_Preview, Dtk_Entity, Dtk_picture, Dtk_OverrideSet, Dtk_OverrideInfo, Dtk_MainDoc, Dtk_Component, Dtk_Node, Dtk_DocElement, Dtk_Log, and Dtk_Properties.

◆ dump()

virtual void Dtk_Object::dump ( FILE *  file = stdout)
virtualinherited

◆ GetCustomData()

Dtk_tab<Dtk_MetaDataPtr> const& Dtk_PhysicalMaterialInfos::GetCustomData ( )

Returns the material custom data.

Returns
the custom data as Dtk_tab<Dtk_MetaDataPtr>.

◆ GetDensity()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::GetDensity ( Dtk_Double64 &  outValue,
Dtk_string &  outUnits 
) const

Returns the material density.

Parameters
[out]outValue: the density value.
[out]outUnits: the density unit as a Dtk_string.
Returns
dtkErrorNotProcessed if not applicable, dtkNoError if value is correctly returned.

◆ GetHardeningRatio()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::GetHardeningRatio ( Dtk_Double64  ouHardeningRatio[3]) const

Returns the material hardening ratio.

Parameters
[out]ouHardeningRatio: the hardening ratio values.
Returns
dtkErrorNotProcessed if not applicable, dtkNoError if value is correctly returned.

◆ GetName()

Dtk_string Dtk_PhysicalMaterialInfos::GetName ( ) const

Returns the material name.

Returns
the material name as a Dtk_string.

◆ GetPoissonRatio()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::GetPoissonRatio ( Dtk_Double64  outPoissonRatio[3]) const

Returns the material poisson ratio.

Parameters
[out]outShearModulus: the poisson ratio values.
Returns
dtkErrorNotProcessed if not applicable, dtkNoError if value is correctly returned.

◆ GetShearModulus()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::GetShearModulus ( Dtk_Double64  outShearModulus[3],
Dtk_string &  outUnits 
) const

Returns the material shear modulus.

Parameters
[out]outShearModulus: the shear modulus values.
[out]outUnits: the shear modulus unit as a Dtk_string.
Returns
dtkErrorNotProcessed if not applicable, dtkNoError if value is correctly returned.

◆ GetSize()

virtual Dtk_Size_t Dtk_Object::GetSize ( ) const
virtualinherited

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_mesh_face, Dtk_mesh, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, Dtk_Point, Dtk_Entity, and Dtk_Info.

◆ GetSpecificHeat()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::GetSpecificHeat ( Dtk_Double64 &  outValue,
Dtk_string &  outUnits 
) const

Returns the material specific heat.

Parameters
[out]outValue: the specific heat value.
[out]outUnits: the specific heat unit as a Dtk_string.
Returns
dtkErrorNotProcessed if not applicable, dtkNoError if value is correctly returned.

◆ GetTensileStrength()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::GetTensileStrength ( Dtk_Double64 &  outValue,
Dtk_string &  outUnits 
) const

Returns the material tensile strength.

Parameters
[out]outValue: the tensile strength value.
[out]outUnits: the tensile strength unit as a Dtk_string.
Returns
dtkErrorNotProcessed if not applicable, dtkNoError if value is correctly returned.

◆ GetThermalConductivity()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::GetThermalConductivity ( Dtk_Double64 &  outValue,
Dtk_string &  outUnits 
) const

Returns the material thermal conductivity.

Parameters
[out]outValue: the thermal conductivity value.
[out]outUnits: the thermal conductivity unit as a Dtk_string.
Returns
dtkErrorNotProcessed if not applicable, dtkNoError if value is correctly returned.

◆ GetThermalExpansion()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::GetThermalExpansion ( Dtk_Double64 &  outValue,
Dtk_string &  outUnits 
) const

Returns the material thermal expansion.

Parameters
[out]outValue: the thermal expansion value.
[out]outUnits: the thermal expansion unit as a Dtk_string.
Returns
dtkErrorNotProcessed if not applicable, dtkNoError if value is correctly returned.

◆ GetType()

MaterialSymetryType Dtk_PhysicalMaterialInfos::GetType ( ) const

Returns the material type.

Returns
the material type.

◆ GetTypeAsString()

Dtk_string Dtk_PhysicalMaterialInfos::GetTypeAsString ( ) const

Returns the material type as a Dtk_string.

Returns
the material type as a Dtk_string.

◆ GetYieldStrength()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::GetYieldStrength ( Dtk_Double64 &  outValue,
Dtk_string &  outUnits 
) const

Returns the material yield strength.

Parameters
[out]outValue: the yield strength value.
[out]outUnits: the yield strength unit as a Dtk_string.
Returns
dtkErrorNotProcessed if not applicable, dtkNoError if value is correctly returned.

◆ GetYoungModulus()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::GetYoungModulus ( Dtk_Double64  outYoungModulus[3],
Dtk_string &  outUnits 
) const

Returns the material young modulus.

Parameters
[out]outYoungModulus: the young modulus values.
[out]outUnits: the tensile strength unit as a Dtk_string.
Returns
dtkErrorNotProcessed if not applicable, dtkNoError if value is correctly returned.

◆ SetCustomData()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::SetCustomData ( Dtk_tab< Dtk_MetaDataPtr >  inCustomData)

Sets the material custom data.

Parameters
[in]inCustomData: the custom data as Dtk_tab<Dtk_MetaDataPtr>.
Returns
dtkNoError.

◆ SetDensity()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::SetDensity ( Dtk_Double64  inValue,
Dtk_string  inUnits 
)

Sets the material density.

Parameters
[in]inValue: the desired density value.
[in]inUnits: the desired density unit as a Dtk_string.
Returns
dtkNoError.

◆ SetHardeningRatio()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::SetHardeningRatio ( Dtk_Double64  inHardeningRatio[3])

Sets the material hardening ratio.

Parameters
[in]inHardeningRatio: the desired hardening ratio values.
Returns
dtkNoError.

◆ SetName()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::SetName ( Dtk_string  inName)

Sets the material name.

Parameters
[in]inName: the desired name.
Returns
dtkNoError.

◆ SetPoissonRatio()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::SetPoissonRatio ( Dtk_Double64  inPoissonRatio[3])

Sets the material poisson ratio.

Parameters
[in]inPoissonRatio: the desired poisson ratio values.
Returns
dtkNoError.

◆ SetShearModulus()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::SetShearModulus ( Dtk_Double64  inShearModulus[3],
Dtk_string  inUnits 
)

Sets the material shear modulus.

Parameters
[in]inShearModulus: the desired shear modulus values.
[in]inUnits: the desired shear modulus unit as a Dtk_string.
Returns
dtkNoError.

◆ SetSpecificHeat()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::SetSpecificHeat ( Dtk_Double64  inValue,
Dtk_string  inUnits 
)

Sets the material specific heat.

Parameters
[in]inValue: the desired specific heat value.
[in]inUnits: the desired specific heat unit as a Dtk_string.
Returns
dtkNoError.

◆ SetTensileStrength()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::SetTensileStrength ( Dtk_Double64  inValue,
Dtk_string  inUnits 
)

Sets the material tensile strength.

Parameters
[in]inValue: the desired specific heat value.
[in]inUnits: the desired specific heat unit as a Dtk_string.
Returns
dtkNoError.

◆ SetThermalConductivity()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::SetThermalConductivity ( Dtk_Double64  inValue,
Dtk_string  inUnits 
)

Sets the material thermal conductivity.

Parameters
[in]inValue: the desired thermal conductivity value.
[in]inUnits: the desired thermal conductivity unit as a Dtk_string.
Returns
dtkNoError.

◆ SetThermalExpansion()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::SetThermalExpansion ( Dtk_Double64  inValue,
Dtk_string  inUnits 
)

Sets the material thermal expansion.

Parameters
[in]inValue: the desired thermal expansion value.
[in]inUnits: the desired thermal expansion unit as a Dtk_string.
Returns
dtkNoError.

◆ SetType()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::SetType ( MaterialSymetryType  inType)

Sets the material type.

Parameters
[in]inType: the desired type.
Returns
dtkNoError.

◆ SetYieldStrength()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::SetYieldStrength ( Dtk_Double64  inValue,
Dtk_string  inUnits 
)

Sets the material yield strength.

Parameters
[in]inValue: the desired yield strength value.
[in]inUnits: the desired yield strength unit as a Dtk_string.
Returns
dtkNoError.

◆ SetYoungModulus()

Dtk_ErrorStatus Dtk_PhysicalMaterialInfos::SetYoungModulus ( Dtk_Double64  inYoungModulus[3],
Dtk_string  inUnits 
)

Sets the material young modulus.

Parameters
[in]inYoungModulus: the desired young modulus values.
[in]inUnits: the desired young modulus unit as a Dtk_string.
Returns
dtkNoError.

Field Documentation

◆ _Private

Dtk_Handle* Dtk_PhysicalMaterialInfos::_Private
protected

◆ count_

unsigned long Dtk_Object::count_
protectedinherited
DTK_TYPE_MATERIAL_INFOS
@ DTK_TYPE_MATERIAL_INFOS
Definition: define.h:516
DTK_TYPE_OBJECT
@ DTK_TYPE_OBJECT
Definition: define.h:455
Dtk_PhysicalMaterialInfos::Orthotrope
@ Orthotrope
Definition: dtk_render.hpp:398
Dtk_PhysicalMaterialInfos::UnknownType
@ UnknownType
Definition: dtk_render.hpp:395
Dtk_PhysicalMaterialInfos::IsotropeTrans
@ IsotropeTrans
Definition: dtk_render.hpp:397
Dtk_PhysicalMaterialInfos
Definition: dtk_render.hpp:390
Dtk_Object::_typeID
@ _typeID
Definition: dtk_object.hpp:10
Dtk_Object::DtkDynamicType
virtual int DtkDynamicType(const int &inId)=0
Dtk_PhysicalMaterialInfos::_typeID
@ _typeID
Definition: dtk_render.hpp:402
Dtk_PhysicalMaterialInfos::Isotropic
@ Isotropic
Definition: dtk_render.hpp:396
Dtk_PhysicalMaterialInfos::Dtk_PhysicalMaterialInfos
Dtk_PhysicalMaterialInfos(const Dtk_PhysicalMaterialInfos &inToBeCopied)
\Copy Constructor{inToBeCopied}