netdem::ModifierManager Class Reference

A class used to manage modifiers in a simulation. More...

#include <modifier_manager.hpp>

Public Member Functions
	ModifierManager ()
	Default constructor for ModifierManager class.
void	Init (Simulation *s)
	Initializes the ModifierManager instance.
Modifier *	Insert (Modifier *e)
	Inserts new modifier into the simulation.
void	RemoveModifier (std::string const &label)
	Removes a modifier from the simulation.
void	Enable (std::string const &label)
	Enables a modifier in the simulation.
void	Disable (std::string const &label)
	Disables a modifier in the simulation.
void	Enable (Modifier *const e)
	Enables a modifier in the simulation.
void	Disable (Modifier *const e)
	Disables a modifier in the simulation.
Modifier *	FindModifier (std::string const &label)
	Finds a modifier in the simulation by label.
bool	FindModifier (Modifier *const e)
	Finds a modifier in the simulation by pointer.
void	UpdateModifiers ()
	Updates the modifiers in the scene_state_subscribers when the scene changes.
void	ExecuteModifiers (DEMSolver::CyclePoint cycle_point)
	Executes all modifiers during the specified cycle point of the DEM solver.
	~ModifierManager ()
	Destructor for ModifierManager class.

Detailed Description

A class used to manage modifiers in a simulation.

The ModifierManager class handles the activation and deactivation of modifiers, as well as the updating of modifier properties when the scene changes.

Constructor & Destructor Documentation

ModifierManager()

netdem::ModifierManager::ModifierManager

(

)

Default constructor for ModifierManager class.

~ModifierManager()

netdem::ModifierManager::~ModifierManager

(

)

Destructor for ModifierManager class.

Member Function Documentation

Disable() [1/2]

void netdem::ModifierManager::Disable

(

Modifier *const

e

)

Disables a modifier in the simulation.

Parameters

e	Pointer to the modifier to be disabled.

Disable() [2/2]

void netdem::ModifierManager::Disable

(

std::string const &

label

)

Disables a modifier in the simulation.

Parameters

label

Label of the modifier to be disabled.

Examples

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

Enable() [1/2]

void netdem::ModifierManager::Enable

(

Modifier *const

e

)

Enables a modifier in the simulation.

Parameters

e	Pointer to the modifier to be enabled.

Enable() [2/2]

void netdem::ModifierManager::Enable

(

std::string const &

label

)

Enables a modifier in the simulation.

Parameters

label

Label of the modifier to be enabled.

Examples

00_nut_in_bolt.cpp, 02_energy_test.cpp, 0_geometric_solver.cpp, 0_plane_case.cpp, 1_gjk_solver.cpp, 1_membrane_case.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.

ExecuteModifiers()

void netdem::ModifierManager::ExecuteModifiers

(

DEMSolver::CyclePoint

cycle_point

)

Executes all modifiers during the specified cycle point of the DEM solver.

Parameters

cycle_point

The cycle point to execute modifiers at.

FindModifier() [1/2]

bool netdem::ModifierManager::FindModifier

(

Modifier *const

e

)

Finds a modifier in the simulation by pointer.

Parameters

e	Pointer to the modifier to find.

Returns

True if the modifier is found, false otherwise.

FindModifier() [2/2]

Modifier * netdem::ModifierManager::FindModifier

(

std::string const &

label

)

Finds a modifier in the simulation by label.

Parameters

label

Label of the modifier to find.

Returns

Pointer to the found Modifier object.

Init()

void netdem::ModifierManager::Init

(

Simulation *

s

)

Initializes the ModifierManager instance.

Parameters

s	Pointer to the current simulation object.

Insert()

Modifier * netdem::ModifierManager::Insert

(

Modifier *

e

)

Inserts new modifier into the simulation.

Parameters

e	Pointer to the modifier to be inserted.

Returns

Pointer to the inserted modifier object.

Examples

00_nut_in_bolt.cpp, 02_energy_test.cpp, 0_geometric_solver.cpp, 0_plane_case.cpp, 1_gjk_solver.cpp, 1_membrane_case.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.

RemoveModifier()

void netdem::ModifierManager::RemoveModifier

(

std::string const &

label

)

Removes a modifier from the simulation.

Parameters

label

Label of the modifier to be removed.

UpdateModifiers()

void netdem::ModifierManager::UpdateModifiers

(

)

Updates the modifiers in the scene_state_subscribers when the scene changes.

---

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

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