GranOO3::PlugIn::ConductCurrent Class Reference

#include <ConductCurrent.hpp>

Inheritance diagram for GranOO3::PlugIn::ConductCurrent:

Public Types
enum	Strategy { SURFACE , CUSTOM , BOND }

Public Member Functions
	ConductCurrent ()
	~ConductCurrent ()
void	parse_xml ()
void	init ()
void	run ()
double	get_equivalent_resistance () const
double	compute_resistance (const DEM::Element &element1, const DEM::Element &element2) const
Public Member Functions inherited from GranOO3::Core::PlugInInterface< ConductCurrent >
virtual	~PlugInInterface ()
Public Member Functions inherited from GranOO3::Core::PlugIn
	PlugIn (const std::string &id)
virtual	~PlugIn ()
const std::string &	get_ID () const
void	verbose ()
void	run_and_init ()
void	trigger_signal_run ()
double	get_elapsed_time ()
int	get_instance_number ()
void	trigger_signal (const std::string &sigID)
virtual void	read_xml_element (const TiXmlElement *el, bool verbose=false)
bool	is_multi_thread () const
bool	is_trigger () const
bool	is_stop () const
void	stop ()
void	unstop ()
void	set_tot_iter_number (unsigned int)
Public Member Functions inherited from GranOO3::Core::NeedSetOf< DEM::Element >
	NeedSetOf (bool required=true)
virtual	~NeedSetOf ()
bool	get_required_flag (unsigned int rank=0) const
void	set_required_flag (bool flag, unsigned int rank=0)
const std::string &	get_xml_flag_name (unsigned int rank=0) const
void	set_xml_flag_name (const std::string &str, unsigned int rank=0)
const std::string &	get_xml_flag_nameByRank (unsigned int rank) const
void	set_xml_flag_name_by_rank (const std::string &str, unsigned int rank)
bool	is_setof_defined (unsigned int rank=0) const
Core::SetOf< DEM::Element > &	get_setof (unsigned int rank=0)
const Core::SetOf< DEM::Element > &	get_setof (unsigned int rank=0) const
void	set_setof (Core::SetOf< DEM::Element > &set, unsigned int rank=0)

Private Member Functions
	DECLARE_STD_GRANOO_PLUGIN (CONDUCT-CURRENT)

Private Attributes
Strategy	_strategy
double	_equivalent_resistance
bool	_verbose
bool	_export_matrix

Additional Inherited Members
Static Public Member Functions inherited from GranOO3::Core::PlugInInterface< ConductCurrent >
static PlugIn *	build ()
static ConductCurrent &	get (unsigned int=0)
static bool	exist (unsigned int rank=0)
static bool	record (const std::string file, const std::string desc="")
Static Public Member Functions inherited from GranOO3::Core::PlugIn
static PlugIn &	get (const std::string &id, unsigned int rank=0)
static std::map< std::string, std::vector< PlugIn * > >	get_all_plugin ()
static std::vector< PlugIn * >	get_all_plugin_vector ()
static bool	exist (const std::string &id, unsigned int rank=0)
static const std::string	class_ID ()
Static Public Member Functions inherited from GranOO3::Core::ObjectFactoryInterface< BaseClass, ChildClass >
static BaseClass *	build ()
static bool	record (const std::string &id, std::string file_name="", std::string desc="")
Static Public Member Functions inherited from GranOO3::Core::ObjectFactory< BaseClass >
static void	record (std::function< BaseClass *()>, const std::string &, const std::string file="", const std::string desc="")
static BaseClass *	new_object (const std::string &)
static std::vector< std::string >	get_ID ()
static std::map< const std::string, std::function< BaseClass *()> > &	get_map ()
Protected Member Functions inherited from GranOO3::Core::PlugInInterface< ConductCurrent >
	PlugInInterface ()
Protected Member Functions inherited from GranOO3::Core::ObjectFactoryInterface< BaseClass, ChildClass >
	ObjectFactoryInterface ()
virtual	~ObjectFactoryInterface ()
Protected Member Functions inherited from GranOO3::Core::ObjectFactory< BaseClass >
	ObjectFactory ()
virtual	~ObjectFactory ()
Protected Attributes inherited from GranOO3::Core::PlugIn
std::vector< PlugIn * >	_subplugin
PlugIn *	_current_subplugin
const std::string	_ID
const std::string	_description
PlugIn *	_parent
bool	_init
bool	_can_run
bool	_verbose
unsigned int	_current_iter_number
unsigned int	_iter_number
double	_total_time
bool	_stop
unsigned int	_every_iter
double	_step_time
unsigned int	_nb_outputs
Math::Expression *	_trigger_if_expr
Math::Expression *	_init_if_expr
std::chrono::microseconds	_elapsed_time

Member Enumeration Documentation

Strategy

enum GranOO3::PlugIn::ConductCurrent::Strategy

Enumerator
SURFACE
CUSTOM
BOND

Constructor & Destructor Documentation

ConductCurrent()

GranOO3::PlugIn::ConductCurrent::ConductCurrent

(

)

~ConductCurrent()

GranOO3::PlugIn::ConductCurrent::~ConductCurrent

(

)

Member Function Documentation

compute_resistance()

double GranOO3::PlugIn::ConductCurrent::compute_resistance	(	const DEM::Element &	element1,
		const DEM::Element &	element2
	)		const

DECLARE_STD_GRANOO_PLUGIN()

GranOO3::PlugIn::ConductCurrent::DECLARE_STD_GRANOO_PLUGIN ( CONDUCT-  CURRENT )

private

get_equivalent_resistance()

double GranOO3::PlugIn::ConductCurrent::get_equivalent_resistance

(

)

const

init()

void GranOO3::PlugIn::ConductCurrent::init ( )

virtual

Reimplemented from GranOO3::Core::PlugIn.

parse_xml()

void GranOO3::PlugIn::ConductCurrent::parse_xml ( )

virtual

Reimplemented from GranOO3::Core::NeedSetOf< DEM::Element >.

run()

void GranOO3::PlugIn::ConductCurrent::run ( )

virtual

Reimplemented from GranOO3::Core::PlugIn.

Member Data Documentation

_equivalent_resistance

double GranOO3::PlugIn::ConductCurrent::_equivalent_resistance

private

_export_matrix

bool GranOO3::PlugIn::ConductCurrent::_export_matrix

private

_strategy

Strategy GranOO3::PlugIn::ConductCurrent::_strategy

private

_verbose

bool GranOO3::PlugIn::ConductCurrent::_verbose

private

---

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

• /home/granoo/granoo/Lib/GranOO3/PlugIn/ConductCurrent.hpp
• /home/granoo/granoo/Lib/GranOO3/PlugIn/ConductCurrent.cpp