netdem::UnbalancedForceRatioEvaluator Class Reference

A class used to evaluate the unbalanced force ratio of particles in a DEM simulation. More...

#include <unbal_force_ratio_evaluator.hpp>

Inheritance diagram for netdem::UnbalancedForceRatioEvaluator:

Public Member Functions
	UnbalancedForceRatioEvaluator ()
	Default constructor for UnbalancedForceRatioEvaluator class.
Modifier *	Clone () const override
	Clones the current UnbalancedForceRatioEvaluator instance.
void	Execute () override
	Executes the UnbalancedForceRatioEvaluator instance.
Public Member Functions inherited from netdem::Modifier
	Modifier ()
	Default constructor for Modifier class.
virtual void	Init (Simulation *sim)
	Initializes the Modifier instance.
virtual void	Enable ()
	Enables the Modifier instance.
virtual void	Disable ()
	Disables the Modifier instance.
virtual void	Update ()
	Updates the Modifier instance.
virtual	~Modifier ()
	Destructor for Modifier class.

Additional Inherited Members
Public Attributes inherited from netdem::Modifier
std::string	label {"default"}
DEMSolver::CyclePoint	cycle_point {DEMSolver::CyclePoint::pre}
Simulation *	sim {nullptr}
Scene *	scene {nullptr}
bool	update_with_scene {false}
bool	enable_logging {true}

Detailed Description

A class used to evaluate the unbalanced force ratio of particles in a DEM simulation.

The UnbalancedForceRatioEvaluator class calculates the unbalanced force ratio for all particles in the simulation.

Constructor & Destructor Documentation

UnbalancedForceRatioEvaluator()

UnbalancedForceRatioEvaluator::UnbalancedForceRatioEvaluator

(

)

Default constructor for UnbalancedForceRatioEvaluator class.

Member Function Documentation

Clone()

Modifier * UnbalancedForceRatioEvaluator::Clone ( ) const

overridevirtual

Clones the current UnbalancedForceRatioEvaluator instance.

Returns

A pointer to the cloned UnbalancedForceRatioEvaluator instance.

Reimplemented from netdem::Modifier.

Execute()

void UnbalancedForceRatioEvaluator::Execute ( )

overridevirtual

Executes the UnbalancedForceRatioEvaluator instance.

Reimplemented from netdem::Modifier.

---

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

• /Users/lzhshou/Documents/Research/myProjects/apaam/repo/netdem/src/modifier/unbal_force_ratio_evaluator.hpp
• /Users/lzhshou/Documents/Research/myProjects/apaam/repo/netdem/src/modifier/unbal_force_ratio_evaluator.cpp