DATAKIT API  V2025.1
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends
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 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 > const &inCustomData)
 Set the material Custom data. More...
 
Dtk_ErrorStatus SetDensity (Dtk_Double64 inValue, const Dtk_string &inUnits)
 Set the material density. More...
 
Dtk_ErrorStatus SetHardeningRatio (Dtk_Double64 inHardeningRatio[3])
 Set the material Hardening Ratio. More...
 
Dtk_ErrorStatus SetPoissonRatio (Dtk_Double64 inPoissonRatio[3])
 Set the material Poisson Ratio. More...
 
Dtk_ErrorStatus SetShearModulus (Dtk_Double64 inShearModulus[3], const Dtk_string &inUnits)
 Set the material Shear Modulus. More...
 
Dtk_ErrorStatus SetSpecificHeat (Dtk_Double64 inValue, const Dtk_string &inUnits)
 Set the material Specific Heat. More...
 
Dtk_ErrorStatus SetTensileStrength (Dtk_Double64 inValue, const Dtk_string &inUnits)
 Set the material Tensile Strength. More...
 
Dtk_ErrorStatus SetThermalConductivity (Dtk_Double64 inValue, const Dtk_string &inUnits)
 Set the material Thermal Conductivity. More...
 
Dtk_ErrorStatus SetThermalExpansion (Dtk_Double64 inValue, const Dtk_string &inUnits)
 Set the material Thermal Expansion. More...
 
Dtk_ErrorStatus SetYieldStrength (Dtk_Double64 inValue, const Dtk_string &inUnits)
 Set the material Yield Strength. More...
 
Dtk_ErrorStatus SetYoungModulus (Dtk_Double64 inYoungModulus[3], const Dtk_string &inUnits)
 Set the material Young Modulus. More...
 

Static Public Member Functions

static Dtk_PhysicalMaterialInfosPtr Create (const Dtk_string &inName, MaterialSymetryType inType)
 Create 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

void _copy (const Dtk_Object &s)
 
void _Copy (const Dtk_PhysicalMaterialInfos &inToBeCopied)
 
void _init ()
 
void _Init ()
 
void _reset ()
 
void _Reset ()
 
virtual Dtk_Object * Clone ()
 
 Dtk_PhysicalMaterialInfos (const Dtk_PhysicalMaterialInfos &inToBeCopied)
 \Copy Constructor{inToBeCopied} More...
 
 Dtk_PhysicalMaterialInfos (const Dtk_string &inName, MaterialSymetryType inType)
 
virtual ~Dtk_PhysicalMaterialInfos ()
 Destructor. More...
 

Protected Attributes

Dtk_Handle * _Private
 
unsigned long count_
 

Friends

class Dtk_SmartPtr< Dtk_PhysicalMaterialInfos >
 

Member Enumeration Documentation

◆ anonymous enum

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

◆ anonymous enum

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

◆ MaterialSymetryType

enum Dtk_PhysicalMaterialInfos::MaterialSymetryType
Enumerator
UnknownType 
Isotropic 
IsotropeTrans 
Orthotrope 
385  {
386  UnknownType = 0,
387  Isotropic = 1,
388  IsotropeTrans = 2,
389  Orthotrope = 3
390  };

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 ( const Dtk_string &  inName,
MaterialSymetryType  inType 
)
protected
See also
Create Dtk_PhysicalMaterialInfos

◆ ~Dtk_PhysicalMaterialInfos()

virtual Dtk_PhysicalMaterialInfos::~Dtk_PhysicalMaterialInfos ( )
protectedvirtual

Destructor.

Member Function Documentation

◆ _copy()

void Dtk_Object::_copy ( const Dtk_Object &  s)
protectedinherited

◆ _Copy()

void Dtk_PhysicalMaterialInfos::_Copy ( const Dtk_PhysicalMaterialInfos &  inToBeCopied)
protected

◆ _init()

void Dtk_Object::_init ( )
protectedinherited

◆ _Init()

void Dtk_PhysicalMaterialInfos::_Init ( )
protected

◆ _reset()

void Dtk_Object::_reset ( )
protectedinherited

◆ _Reset()

void Dtk_PhysicalMaterialInfos::_Reset ( )
protected

◆ Clone()

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

◆ Create()

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

Create a Dtk_MaterialInfosPtr.

Parameters
inNamename.
Returns
the constructed Dtk_MaterialInfosPtr.

◆ DtkDynamicCast()

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

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

429  {
430  if (s->DtkDynamicType(_typeID)) return static_cast<Dtk_PhysicalMaterialInfos*>(s);
431  return NULL;
432  }

◆ DtkDynamicType() [1/2]

Dtk_Int32 Dtk_PhysicalMaterialInfos::DtkDynamicType ( const Dtk_Int32 &  inId)

Retrieves the dynamic entity type.

422  {
423  if (inId == _typeID) return 1;
424  return Dtk_Object::DtkDynamicType(inId);
425  }

◆ 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.

◆ GetDensity()

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

Returns the material density.

◆ GetHardeningRatio()

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

Returns the material Hardening Ratio.

◆ GetName()

Dtk_string Dtk_PhysicalMaterialInfos::GetName ( ) const

Returns the material name.

◆ GetPoissonRatio()

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

Returns the material Poisson Ratio.

◆ GetShearModulus()

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

Returns the material Shear Modulus.

◆ 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.

◆ GetTensileStrength()

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

Returns the material Tensile Strength.

◆ GetThermalConductivity()

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

Returns the material Thermal Conductivity.

◆ GetThermalExpansion()

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

Returns the material Thermal Expansion.

◆ GetType()

MaterialSymetryType Dtk_PhysicalMaterialInfos::GetType ( ) const

Returns the material type.

◆ GetTypeAsString()

Dtk_string Dtk_PhysicalMaterialInfos::GetTypeAsString ( ) const

Returns the material type as string.

◆ GetYieldStrength()

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

Returns the material Yield Strength.

◆ GetYoungModulus()

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

Returns the material Young Modulus.

◆ SetCustomData()

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

Set the material Custom data.

◆ SetDensity()

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

Set the material density.

◆ SetHardeningRatio()

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

Set the material Hardening Ratio.

◆ SetPoissonRatio()

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

Set the material Poisson Ratio.

◆ SetShearModulus()

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

Set the material Shear Modulus.

◆ SetSpecificHeat()

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

Set the material Specific Heat.

◆ SetTensileStrength()

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

Set the material Tensile Strength.

◆ SetThermalConductivity()

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

Set the material Thermal Conductivity.

◆ SetThermalExpansion()

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

Set the material Thermal Expansion.

◆ SetYieldStrength()

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

Set the material Yield Strength.

◆ SetYoungModulus()

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

Set the material Young Modulus.

Friends And Related Function Documentation

◆ Dtk_SmartPtr< Dtk_PhysicalMaterialInfos >

friend class Dtk_SmartPtr< Dtk_PhysicalMaterialInfos >
friend

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:525
DTK_TYPE_OBJECT
@ DTK_TYPE_OBJECT
Definition: define.h:464
Dtk_PhysicalMaterialInfos::Orthotrope
@ Orthotrope
Definition: dtk_render.hpp:389
Dtk_PhysicalMaterialInfos::UnknownType
@ UnknownType
Definition: dtk_render.hpp:386
Dtk_PhysicalMaterialInfos::IsotropeTrans
@ IsotropeTrans
Definition: dtk_render.hpp:388
Dtk_PhysicalMaterialInfos
Definition: dtk_render.hpp:381
Dtk_Object::_typeID
@ _typeID
Definition: dtk_object.hpp:13
Dtk_Object::DtkDynamicType
virtual int DtkDynamicType(const int &inId)=0
Dtk_PhysicalMaterialInfos::_typeID
@ _typeID
Definition: dtk_render.hpp:393
Dtk_PhysicalMaterialInfos::Isotropic
@ Isotropic
Definition: dtk_render.hpp:387
Dtk_PhysicalMaterialInfos::Dtk_PhysicalMaterialInfos
Dtk_PhysicalMaterialInfos(const Dtk_PhysicalMaterialInfos &inToBeCopied)
\Copy Constructor{inToBeCopied}