GranOO  3.0
A robust and versatile workbench to build 3D dynamic simulations based on the Discrete Element Method
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
GranOO3::DEM::Thermal Class Reference

a property for adding thermal physics to DEM::Element More...

#include <Thermal.hpp>

Inheritance diagram for GranOO3::DEM::Thermal:
Inheritance graph
[legend]

Public Member Functions

 Thermal ()
 constructor More...
 
virtual ~Thermal ()
 destructor More...
 
virtual std::string info () const
 
- Public Member Functions inherited from GranOO3::Core::Prop< Element >
 Prop ()
 
virtual ~Prop ()
 
Element & item ()
 
const Element & item () const
 
void set_item (Element &)
 
virtual void set_color (const Core::Color &)
 
Core::Colorget_color ()
 
float & get_line_width ()
 
virtual void add (SetOf< Prop< Element > > *)
 
virtual void erase (SetOf< Prop< Element > > *)
 
virtual std::ostream & write_ascii (std::ostream &out) const
 
virtual std::istream & read_ascii (std::istream &in)
 
- Public Member Functions inherited from GranOO3::Core::Base
virtual ~Base ()
 
size_t numID () const
 
size_t uID () const
 
void set_numID (size_t val)
 
void clear_numID ()
 
Physic::Materialget_mat () const
 
void set_mat (Physic::Material *)
 
Baseitem ()
 
const Baseitem () const
 
bool is_same (const Base &) const
 
template<class T >
T & cast_to ()
 
template<class T >
const T & cast_to () const
 
template<class T >
bool is () const
 
virtual bool is (size_t) const
 
virtual const std::string & get_ID () const
 
virtual Baseclone ()
 
template<class T >
T & clone_to ()
 
virtual std::ostream & export_to_povray (std::ostream &out) const
 
Signal< Base & > & deleted_signal ()
 
- Public Member Functions inherited from GranOO3::Core::Null
 Null ()
 
virtual ~Null ()
 
- Public Member Functions inherited from GranOO3::Core::Drawable
 Drawable ()
 
virtual ~Drawable ()
 
virtual void draw ()
 
virtual void draw_edge ()
 
virtual void init_default_color ()
 
virtual std::ostream & get_info (std::ostream &os) const
 
virtual const Colordefault_color () const
 
Colorget_color ()
 
const Colorget_color () const
 
virtual void set_alpha (float alpha)
 
void apply_color () const
 
void apply_edge_color () const
 
void apply_default_color ()
 
void apply_selected_color ()
 
void set_line_width (float)
 
float get_line_width () const
 
float & get_line_width ()
 
void apply_line_width () const
 
bool is_visible () const
 
void set_visible (bool)
 
void paint ()
 
void paint_edge ()
 
unsigned int get_item_glkey () const
 
- Public Member Functions inherited from GranOO3::Core::Register< Base >
 Register ()
 
virtual ~Register ()
 
void erase_from_all_setof ()
 
bool belong_to_setof (const std::string &setOfId) const
 
bool belong_to_setof (const SetOf< Base > &set) const
 
std::list< SetOf< Base > * > & get_setof_list ()
 
unsigned long long int get_numeric_ID () const
 
- Public Member Functions inherited from GranOO3::Core::Register< type >
 Register ()
 
virtual ~Register ()
 
void erase_from_all_setof ()
 
bool belong_to_setof (const std::string &setOfId) const
 
bool belong_to_setof (const SetOf< type > &set) const
 
std::list< SetOf< type > * > & get_setof_list ()
 
unsigned long long int get_numeric_ID () const
 
- Public Member Functions inherited from GranOO3::Core::Register< Thermal >
 Register ()
 
virtual ~Register ()
 
void erase_from_all_setof ()
 
bool belong_to_setof (const std::string &setOfId) const
 
bool belong_to_setof (const SetOf< Thermal > &set) const
 
std::list< SetOf< Thermal > * > & get_setof_list ()
 
unsigned long long int get_numeric_ID () const
 

Private Member Functions

template<class Archive >
void serialize (Archive &ar, const unsigned int)
 complete serializing of the instance in the *.gdd format More...
 

Private Attributes

double _capacity
 The thermal capacity of the element (same as the simulated material) More...
 
double _conductivity
 The thermal conductivity of the element (same as the simulated material) More...
 
double _temperature
 The current temperature of the element. More...
 
double _temperature_variation
 The current temperature variation (incremental variation) of the element. More...
 

Friends

class boost::serialization::access
 

Additional Inherited Members

- Public Types inherited from GranOO3::Core::Prop< Element >
typedef Element Owner
 
- Static Public Member Functions inherited from GranOO3::Core::Base
static Baseget_by_numID (size_t)
 
static void clear_all_numID ()
 
static unsigned int get_sub_class_number ()
 
- Static Public Member Functions inherited from GranOO3::Core::Drawable
static Drawableget_drawable_item_by_glkey (int)
 
static void set_draw_precision (unsigned int p)
 
static void increase_draw_precision ()
 
static void decrease_draw_precision ()
 
static unsigned int get_draw_precision ()
 
- Static Public Attributes inherited from GranOO3::Core::Null
static Null null = Null()
 
- Protected Member Functions inherited from GranOO3::Core::Prop< Element >
virtual Basebase_item ()
 
virtual const Basebase_item () const
 
void serialize (Archive &ar, const unsigned int)
 
- Protected Member Functions inherited from GranOO3::Core::Base
 Base ()
 
- Static Protected Member Functions inherited from GranOO3::Core::Base
static unsigned int affect_class_rank_ID ()
 

Detailed Description

a property for adding thermal physics to DEM::Element

The aim of this DEM::Element property is to add thermal properties to DEM::Element. It enables to carry out multi-physics simulation taking into account thermal conduction. For more information, please refer to [1]. See the plugin CONDUCT-HEAT to get more info.

[1] Terreros, I., Iordanoff, I., & Charles, J. L. (2013). Simulation of continuum heat conduction using DEM domains. Computational Materials Science, 69, 46-52.

Constructor & Destructor Documentation

◆ Thermal()

GranOO3::DEM::Thermal::Thermal ( )

constructor

Constructs a new Thermal instance. Do not call this constructor. To build a new Thermal instance, you must create a new property by invoking the Element::new_prop<Thermal>() method of the Element class.

◆ ~Thermal()

GranOO3::DEM::Thermal::~Thermal ( )
virtual

destructor

Destructs an Thermal instance. Be aware, as Thermal is a property, you must not invoke destructor by yourself, it could lead to unexpected behavior. Note that the Thermal instances are automatically destructed when their associated elements are destructed.

Member Function Documentation

◆ info()

std::string GranOO3::DEM::Thermal::info ( ) const
virtual
Returns
Some useful info about the instance

Reimplemented from GranOO3::Core::Prop< Element >.

◆ serialize()

template<class Archive >
void GranOO3::DEM::Thermal::serialize ( Archive &  ar,
const unsigned int   
)
private

complete serializing of the instance in the *.gdd format

See also
the Domain classes to get additional info about I/O

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Member Data Documentation

◆ _capacity

double GranOO3::DEM::Thermal::_capacity
private

The thermal capacity of the element (same as the simulated material)

◆ _conductivity

double GranOO3::DEM::Thermal::_conductivity
private

The thermal conductivity of the element (same as the simulated material)

◆ _temperature

double GranOO3::DEM::Thermal::_temperature
private

The current temperature of the element.

◆ _temperature_variation

double GranOO3::DEM::Thermal::_temperature_variation
private

The current temperature variation (incremental variation) of the element.


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