TexGen
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
TexGen::CPropertiesYarn Class Reference

Class to store properties related to a textile. More...

#include <PropertiesYarn.h>

Inheritance diagram for TexGen::CPropertiesYarn:
Inheritance graph
[legend]

Public Member Functions

 CPropertiesYarn ()
 
 CPropertiesYarn (TiXmlElement &Element)
 
 ~CPropertiesYarn (void)
 
void PopulateTiXmlElement (TiXmlElement &Element, OUTPUT_TYPE OutputType)
 Used for saving data to XML. More...
 
void SetYarnLinearDensity (double dValue, string Units="kg/m")
 Set the fibre linear density, i.e. the mass per unit length of fibre. More...
 
void SetFibreDensity (double dValue, string Units="kg/m^3")
 Set the fibre density, i.e. the mass per unit volume of fibre. More...
 
void SetFibreDiameter (double dValue, string Units="m")
 Set the fibre diameter. More...
 
void SetFibresPerYarn (int iValue)
 Set the number of fibres in a yarn. More...
 
void SetYoungsModulus (double dValue, string Units="MPa")
 Set the Young's modulus for a yarn. More...
 
void SetYoungsModulusX (double dValue, string Units="MPa")
 
void SetYoungsModulusY (double dValue, string Units="MPa")
 
void SetYoungsModulusZ (double dValue, string Units="MPa")
 
void SetShearModulusXY (double dValue, string Units="MPa")
 Set the Shear modulus for a yarn. More...
 
void SetShearModulusXZ (double dValue, string Units="MPa")
 
void SetShearModulusYZ (double dValue, string Units="MPa")
 
void SetPoissonsRatio (double dValue)
 Set the Poisson's ratio for a yarn. More...
 
void SetPoissonsRatioX (double dValue)
 
void SetPoissonsRatioY (double dValue)
 
void SetPoissonsRatioZ (double dValue)
 
void SetAlphaX (double dValue, string Units="/K")
 Set the coefficients of thermal expansion for a yarn. More...
 
void SetAlphaY (double dValue, string Units="/K")
 
void SetAlphaZ (double dValue, string Units="/K")
 
void SetFibreArea (double dValue, string Units="m^2")
 Set the area occupied by fibres in a yarn cross-section. More...
 
void ResetYarnLinearDensity ()
 
void ResetFibreDensity ()
 
void ResetFibreDiameter ()
 
void ResetFibresPerYarn ()
 
void ResetFibreArea ()
 
void ResetYoungsModulusX ()
 
void ResetYoungsModulusY ()
 
void ResetYoungsModulusZ ()
 
void ResetShearModulusXY ()
 
void ResetShearModulusXZ ()
 
void ResetShearModulusYZ ()
 
void ResetAlphaX ()
 
void ResetAlphaY ()
 
void ResetAlphaZ ()
 
void ResetPoissonsRatioX ()
 
void ResetPoissonsRatioY ()
 
void ResetPoissonsRatioZ ()
 
double GetYarnLinearDensity (string Units="kg/m") const
 
double GetFibreDensity (string Units="kg/m^3") const
 
double GetFibreDiameter (string Units="m") const
 
int GetFibresPerYarn () const
 
double GetFibreArea (string Units="m^2") const
 Get the area occupied by fibres given fibre diameter and number of fibres. More...
 
double GetYoungsModulusX (string Units="MPa") const
 
double GetYoungsModulusY (string Units="MPa") const
 
double GetYoungsModulusZ (string Units="MPa") const
 
double GetShearModulusXY (string Units="MPa") const
 
double GetShearModulusXZ (string Units="MPa") const
 
double GetShearModulusYZ (string Units="MPa") const
 
double GetAlphaX (string Units="/K") const
 
double GetAlphaY (string Units="/K") const
 
double GetAlphaZ (string Units="/K") const
 
double GetPoissonsRatioX () const
 
double GetPoissonsRatioY () const
 
double GetPoissonsRatioZ () const
 

Public Attributes

CProperty m_YarnLinearDensity
 
CProperty m_FibreDensity
 
CProperty m_FibreArea
 
CProperty m_FibreDiameter
 
CProperty m_YoungsModulusX
 
CProperty m_YoungsModulusY
 
CProperty m_YoungsModulusZ
 
CProperty m_ShearModulusXY
 
CProperty m_ShearModulusXZ
 
CProperty m_ShearModulusYZ
 
CProperty m_AlphaX
 
CProperty m_AlphaY
 
CProperty m_AlphaZ
 
CProperty m_CalculatedArea
 

Protected Member Functions

void SetDefaultProperties ()
 Set default properties as specified by DefaultProperties.h. More...
 

Protected Attributes

int m_iFibresPerYarn
 
double m_PoissonsRatioX
 
double m_PoissonsRatioY
 
double m_PoissonsRatioZ
 

Detailed Description

Class to store properties related to a textile.

This class combines geometrical information stored in the CTextile class with user input data relating to physical properties of the textile. Several interesting values can be obtained in this manner, for example the volume fraction is calculated from the volume of yarns in the geometrical model along with information about fibre density and areal density.

Definition at line 36 of file PropertiesYarn.h.

Constructor & Destructor Documentation

◆ CPropertiesYarn() [1/2]

CPropertiesYarn::CPropertiesYarn ( )

Definition at line 25 of file PropertiesYarn.cpp.

◆ CPropertiesYarn() [2/2]

CPropertiesYarn::CPropertiesYarn ( TiXmlElement &  Element)

Definition at line 29 of file PropertiesYarn.cpp.

◆ ~CPropertiesYarn()

CPropertiesYarn::~CPropertiesYarn ( void  )

Definition at line 34 of file PropertiesYarn.cpp.

Member Function Documentation

◆ GetAlphaX()

double CProperties::GetAlphaX ( string  Units = "/K") const
inherited

◆ GetAlphaY()

double CProperties::GetAlphaY ( string  Units = "/K") const
inherited

◆ GetAlphaZ()

double CProperties::GetAlphaZ ( string  Units = "/K") const
inherited

◆ GetFibreArea()

double CProperties::GetFibreArea ( string  Units = "m^2") const
inherited

Get the area occupied by fibres given fibre diameter and number of fibres.

Either returns the value stored in m_dFibreArea or calculates it from m_iFibresPerYarn and m_FibreDiameter if they are set OR from m_dYarnLinearDensity and m_dFibreDensity if they are set.

Definition at line 251 of file Properties.cpp.

References TexGen::ConvertUnits(), TexGen::CProperty::GetSIValue(), TexGen::CProperty::GetValue(), TexGen::CProperty::IsSet(), TexGen::CProperties::m_CalculatedArea, TexGen::CProperties::m_FibreArea, TexGen::CProperties::m_FibreDensity, TexGen::CProperties::m_FibreDiameter, TexGen::CProperties::m_iFibresPerYarn, TexGen::CProperties::m_YarnLinearDensity, and PI.

Referenced by TexGen::CTextile3DWeave::GetFibreArea(), TexGen::CYarn::GetFibreVolume(), TexGen::CSimulationAbaqus::GetSectionVolumeFraction(), and TexGen::CYarn::PointInsideYarn().

◆ GetFibreDensity()

double CProperties::GetFibreDensity ( string  Units = "kg/m^3") const
inherited

◆ GetFibreDiameter()

double CProperties::GetFibreDiameter ( string  Units = "m") const
inherited

◆ GetFibresPerYarn()

int CProperties::GetFibresPerYarn ( ) const
inherited

◆ GetPoissonsRatioX()

double CProperties::GetPoissonsRatioX ( ) const
inherited

◆ GetPoissonsRatioY()

double CProperties::GetPoissonsRatioY ( ) const
inherited

◆ GetPoissonsRatioZ()

double CProperties::GetPoissonsRatioZ ( ) const
inherited

◆ GetShearModulusXY()

double CProperties::GetShearModulusXY ( string  Units = "MPa") const
inherited

◆ GetShearModulusXZ()

double CProperties::GetShearModulusXZ ( string  Units = "MPa") const
inherited

◆ GetShearModulusYZ()

double CProperties::GetShearModulusYZ ( string  Units = "MPa") const
inherited

◆ GetYarnLinearDensity()

double CProperties::GetYarnLinearDensity ( string  Units = "kg/m") const
inherited

◆ GetYoungsModulusX()

double CProperties::GetYoungsModulusX ( string  Units = "MPa") const
inherited

◆ GetYoungsModulusY()

double CProperties::GetYoungsModulusY ( string  Units = "MPa") const
inherited

◆ GetYoungsModulusZ()

double CProperties::GetYoungsModulusZ ( string  Units = "MPa") const
inherited

◆ PopulateTiXmlElement()

void CPropertiesYarn::PopulateTiXmlElement ( TiXmlElement &  Element,
OUTPUT_TYPE  OutputType 
)
virtual

Used for saving data to XML.

Reimplemented from TexGen::CProperties.

Reimplemented in TexGen::CYarn.

Definition at line 38 of file PropertiesYarn.cpp.

References TexGen::CProperties::PopulateTiXmlElement().

Referenced by TexGen::CYarn::PopulateTiXmlElement().

◆ ResetAlphaX()

void TexGen::CProperties::ResetAlphaX ( )
inlineinherited

Definition at line 165 of file Properties.h.

◆ ResetAlphaY()

void TexGen::CProperties::ResetAlphaY ( )
inlineinherited

Definition at line 166 of file Properties.h.

◆ ResetAlphaZ()

void TexGen::CProperties::ResetAlphaZ ( )
inlineinherited

Definition at line 167 of file Properties.h.

◆ ResetFibreArea()

void TexGen::CProperties::ResetFibreArea ( )
inlineinherited

Definition at line 158 of file Properties.h.

◆ ResetFibreDensity()

void TexGen::CProperties::ResetFibreDensity ( )
inlineinherited

Definition at line 155 of file Properties.h.

◆ ResetFibreDiameter()

void TexGen::CProperties::ResetFibreDiameter ( )
inlineinherited

Definition at line 156 of file Properties.h.

◆ ResetFibresPerYarn()

void TexGen::CProperties::ResetFibresPerYarn ( )
inlineinherited

Definition at line 157 of file Properties.h.

◆ ResetPoissonsRatioX()

void TexGen::CProperties::ResetPoissonsRatioX ( )
inlineinherited

Definition at line 168 of file Properties.h.

◆ ResetPoissonsRatioY()

void TexGen::CProperties::ResetPoissonsRatioY ( )
inlineinherited

Definition at line 169 of file Properties.h.

◆ ResetPoissonsRatioZ()

void TexGen::CProperties::ResetPoissonsRatioZ ( )
inlineinherited

Definition at line 170 of file Properties.h.

◆ ResetShearModulusXY()

void TexGen::CProperties::ResetShearModulusXY ( )
inlineinherited

Definition at line 162 of file Properties.h.

◆ ResetShearModulusXZ()

void TexGen::CProperties::ResetShearModulusXZ ( )
inlineinherited

Definition at line 163 of file Properties.h.

◆ ResetShearModulusYZ()

void TexGen::CProperties::ResetShearModulusYZ ( )
inlineinherited

Definition at line 164 of file Properties.h.

◆ ResetYarnLinearDensity()

void TexGen::CProperties::ResetYarnLinearDensity ( )
inlineinherited

Definition at line 154 of file Properties.h.

◆ ResetYoungsModulusX()

void TexGen::CProperties::ResetYoungsModulusX ( )
inlineinherited

Definition at line 159 of file Properties.h.

◆ ResetYoungsModulusY()

void TexGen::CProperties::ResetYoungsModulusY ( )
inlineinherited

Definition at line 160 of file Properties.h.

◆ ResetYoungsModulusZ()

void TexGen::CProperties::ResetYoungsModulusZ ( )
inlineinherited

Definition at line 161 of file Properties.h.

◆ SetAlphaX()

void CProperties::SetAlphaX ( double  dValue,
string  Units = "/K" 
)
inherited

Set the coefficients of thermal expansion for a yarn.

Definition at line 204 of file Properties.cpp.

References TexGen::CProperties::m_AlphaX, and TexGen::CProperty::SetValue().

Referenced by TexGen::CProperties::SetDefaultProperties().

◆ SetAlphaY()

void CProperties::SetAlphaY ( double  dValue,
string  Units = "/K" 
)
inherited

◆ SetAlphaZ()

void CProperties::SetAlphaZ ( double  dValue,
string  Units = "/K" 
)
inherited

◆ SetDefaultProperties()

void CProperties::SetDefaultProperties ( )
protectedinherited

◆ SetFibreArea()

void CProperties::SetFibreArea ( double  dValue,
string  Units = "m^2" 
)
inherited

Set the area occupied by fibres in a yarn cross-section.

If not set it can be calculated from the yarn linear density and fibre density.

Definition at line 140 of file Properties.cpp.

References TexGen::CProperties::m_FibreArea, and TexGen::CProperty::SetValue().

Referenced by TexGen::CTextile3DWeave::SetFibreArea(), and TexGen::CTextile3DWeave::SetYarnProperties().

◆ SetFibreDensity()

void CProperties::SetFibreDensity ( double  dValue,
string  Units = "kg/m^3" 
)
inherited

◆ SetFibreDiameter()

void CProperties::SetFibreDiameter ( double  dValue,
string  Units = "m" 
)
inherited

◆ SetFibresPerYarn()

void CProperties::SetFibresPerYarn ( int  iValue)
inherited

◆ SetPoissonsRatio()

void CProperties::SetPoissonsRatio ( double  dValue)
inherited

◆ SetPoissonsRatioX()

void CProperties::SetPoissonsRatioX ( double  dValue)
inherited

◆ SetPoissonsRatioY()

void CProperties::SetPoissonsRatioY ( double  dValue)
inherited

◆ SetPoissonsRatioZ()

void CProperties::SetPoissonsRatioZ ( double  dValue)
inherited

◆ SetShearModulusXY()

void CProperties::SetShearModulusXY ( double  dValue,
string  Units = "MPa" 
)
inherited

Set the Shear modulus for a yarn.

Definition at line 189 of file Properties.cpp.

References TexGen::CProperties::m_ShearModulusXY, and TexGen::CProperty::SetValue().

Referenced by TexGen::CProperties::SetDefaultProperties().

◆ SetShearModulusXZ()

void CProperties::SetShearModulusXZ ( double  dValue,
string  Units = "MPa" 
)
inherited

◆ SetShearModulusYZ()

void CProperties::SetShearModulusYZ ( double  dValue,
string  Units = "MPa" 
)
inherited

◆ SetYarnLinearDensity()

void CProperties::SetYarnLinearDensity ( double  dValue,
string  Units = "kg/m" 
)
inherited

Set the fibre linear density, i.e. the mass per unit length of fibre.

Suppose 1 meter length of yarn weighs X kg, it's linear density is X kg/m

Definition at line 120 of file Properties.cpp.

References TexGen::CProperty::GetSIValue(), TexGen::CProperty::IsSet(), TexGen::CProperties::m_CalculatedArea, TexGen::CProperties::m_FibreDensity, TexGen::CProperties::m_YarnLinearDensity, and TexGen::CProperty::SetValue().

Referenced by TexGen::CTextile3DWeave::SetYarnLinearDensity(), and TexGen::CTextile3DWeave::SetYarnProperties().

◆ SetYoungsModulus()

void CProperties::SetYoungsModulus ( double  dValue,
string  Units = "MPa" 
)
inherited

◆ SetYoungsModulusX()

void CProperties::SetYoungsModulusX ( double  dValue,
string  Units = "MPa" 
)
inherited

◆ SetYoungsModulusY()

void CProperties::SetYoungsModulusY ( double  dValue,
string  Units = "MPa" 
)
inherited

◆ SetYoungsModulusZ()

void CProperties::SetYoungsModulusZ ( double  dValue,
string  Units = "MPa" 
)
inherited

Member Data Documentation

◆ m_AlphaX

CProperty TexGen::CProperties::m_AlphaX
inherited

◆ m_AlphaY

CProperty TexGen::CProperties::m_AlphaY
inherited

◆ m_AlphaZ

CProperty TexGen::CProperties::m_AlphaZ
inherited

◆ m_CalculatedArea

CProperty TexGen::CProperties::m_CalculatedArea
inherited

◆ m_FibreArea

CProperty TexGen::CProperties::m_FibreArea
inherited

◆ m_FibreDensity

CProperty TexGen::CProperties::m_FibreDensity
inherited

◆ m_FibreDiameter

CProperty TexGen::CProperties::m_FibreDiameter
inherited

◆ m_iFibresPerYarn

int TexGen::CProperties::m_iFibresPerYarn
protectedinherited

◆ m_PoissonsRatioX

double TexGen::CProperties::m_PoissonsRatioX
protectedinherited

◆ m_PoissonsRatioY

double TexGen::CProperties::m_PoissonsRatioY
protectedinherited

◆ m_PoissonsRatioZ

double TexGen::CProperties::m_PoissonsRatioZ
protectedinherited

◆ m_ShearModulusXY

CProperty TexGen::CProperties::m_ShearModulusXY
inherited

◆ m_ShearModulusXZ

CProperty TexGen::CProperties::m_ShearModulusXZ
inherited

◆ m_ShearModulusYZ

CProperty TexGen::CProperties::m_ShearModulusYZ
inherited

◆ m_YarnLinearDensity

CProperty TexGen::CProperties::m_YarnLinearDensity
inherited

◆ m_YoungsModulusX

CProperty TexGen::CProperties::m_YoungsModulusX
inherited

◆ m_YoungsModulusY

CProperty TexGen::CProperties::m_YoungsModulusY
inherited

◆ m_YoungsModulusZ

CProperty TexGen::CProperties::m_YoungsModulusZ
inherited

The documentation for this class was generated from the following files: