netdem::Modifier Class Reference

An interface class used to modify a DEM simulation. More...

#include <modifier.hpp>

Inheritance diagram for netdem::Modifier:

Public Member Functions
	Modifier ()
	Default constructor for Modifier class.
virtual Modifier *	Clone () const
	Clones the current Modifier instance.
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	Execute ()
	Executes the Modifier instance.
virtual void	Update ()
	Updates the Modifier instance.
virtual	~Modifier ()
	Destructor for Modifier class.

Public Attributes
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

An interface class used to modify a DEM simulation.

The Modifier class allows for the addition of various features to a DEM simulation, such as the effects of gravity, data dumping, and scene rendering.

Constructor & Destructor Documentation

Modifier()

netdem::Modifier::Modifier

(

)

Default constructor for Modifier class.

~Modifier()

netdem::Modifier::~Modifier ( )

virtual

Destructor for Modifier class.

Member Function Documentation

Clone()

Modifier * netdem::Modifier::Clone ( ) const

virtual

Clones the current Modifier instance.

Returns

A pointer to the cloned Modifier instance.

Reimplemented in netdem::BreakageAnalysis, netdem::BreakageAnalysisPD, netdem::DataDumper, netdem::DeformationAnalysis, netdem::ExternalForce, netdem::Gravity, netdem::MembraneWall, netdem::ParticleEnergyEvaluator, netdem::ParticleGroup, netdem::ParticleMotionControl, netdem::ParticleStressEvaluator, netdem::UnbalancedForceRatioEvaluator, netdem::WallGroup, netdem::WallMotionControl, netdem::WallMotionIntegrator, and netdem::WallServoControl.

Disable()

void netdem::Modifier::Disable ( )

virtual

Disables the Modifier instance.

Enable()

void netdem::Modifier::Enable ( )

virtual

Enables the Modifier instance.

Execute()

void netdem::Modifier::Execute ( )

virtual

Executes the Modifier instance.

This function is called during the specified cycle point of the DEM solver.

Reimplemented in netdem::BreakageAnalysis, netdem::BreakageAnalysisPD, netdem::DataDumper, netdem::DeformationAnalysis, netdem::ExternalForce, netdem::Gravity, netdem::MembraneWall, netdem::ParticleEnergyEvaluator, netdem::ParticleGroup, netdem::ParticleMotionControl, netdem::ParticleStressEvaluator, netdem::UnbalancedForceRatioEvaluator, netdem::WallGroup, netdem::WallMotionControl, netdem::WallMotionIntegrator, and netdem::WallServoControl.

Init()

void netdem::Modifier::Init ( Simulation * sim )

virtual

Initializes the Modifier instance.

Parameters

sim	Pointer to the current simulation object.

Reimplemented in netdem::BreakageAnalysis, netdem::BreakageAnalysisPD, netdem::DataDumper, netdem::DeformationAnalysis, netdem::Gravity, and netdem::MembraneWall.

Examples

02_energy_test.cpp, 0_plane_case.cpp, 1_test_triaxial_comp.cpp, 91_triaixal_comp.cpp, 91_triaixal_comp_trimesh.cpp, 93_triaixal_comp_trimesh.cpp, 97_triaixal_comp_sphere_geom.cpp, and odemetric_comp_main.cpp.

Update()

void netdem::Modifier::Update ( )

virtual

Updates the Modifier instance.

This function is called at each time step of the simulation.

Reimplemented in netdem::BreakageAnalysis, netdem::BreakageAnalysisPD, netdem::DeformationAnalysis, netdem::ExternalForce, netdem::ParticleEnergyEvaluator, netdem::ParticleGroup, netdem::ParticleMotionControl, netdem::ParticleStressEvaluator, netdem::WallGroup, and netdem::WallServoControl.

Member Data Documentation

cycle_point

DEMSolver::CyclePoint netdem::Modifier::cycle_point {DEMSolver::CyclePoint::pre}

enable_logging

bool netdem::Modifier::enable_logging {true}

label

std::string netdem::Modifier::label {"default"}

Examples

00_nut_in_bolt.cpp, 02_energy_test.cpp, 0_geometric_solver.cpp, 0_plane_case.cpp, 1_gjk_solver.cpp, 1_test_triaxial_comp.cpp, 2_sdf_solver.cpp, 3_hybrid_solver.cpp, 81_voronoi_packing.cpp, 90_packing_demo.cpp, 90_random_packing.cpp, 90_random_packing_trimesh.cpp, 91_packing_ellipsoid.cpp, 91_triaixal_comp.cpp, 91_triaixal_comp_trimesh.cpp, 92_angle_of_repose.cpp, 92_angle_repose_trimesh.cpp, 92_nut_in_bolt.cpp, 93_triaixal_comp_trimesh.cpp, 94_angle_repose_trimesh.cpp, 96_random_packing_ellipsoid.cpp, 97_triaixal_comp_sphere_geom.cpp, angle_repose_main.cpp, blade_mixing_main.cpp, landslide_main.cpp, and odemetric_comp_main.cpp.

scene

Scene* netdem::Modifier::scene {nullptr}

sim

Simulation* netdem::Modifier::sim {nullptr}

update_with_scene

bool netdem::Modifier::update_with_scene {false}

---

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

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