This is the base class for both HGRID_2D and HGRID_3D. More...

#include <HGRID_base.h>

Inheritance diagram for HGRID_base:

Public Member Functions
	HGRID_base ()
	This is the default constructor. All it does is set senible defaults. More...

	~HGRID_base ()
	This is the default destructor. More...

	HGRID_base (MD &other)
	Copy-constructor for creates an HGRID problem from an existing MD problem. More...

void	constructor ()
	This is the actually constructor it is called do both constructors above. More...

void	HGRID_actions_before_time_loop ()
	This sets up the broad phase information, has to be done at this stage becuase it requires the partcle size. More...

void	HGRID_actions_before_time_step ()
	This resets all the bucket information. More...

void	set_HGRID_num_buckets (unsigned int new_num_buckets)
	This sets the number of buckets for the HGRID. More...

void	set_HGRID_num_buckets_to_power ()
	set number of buckets to the smallest power of two bigger than the number of particles More...

void	set_HGRID_num_buckets_to_power (unsigned int N)
	set number of buckets to the smallest power of two bigger than N More...

void	read (std::istream &is)
	This function reads all HGRID data. More...

void	write (std::ostream &os)
	This function writes all HGRID data. More...

void	print (std::ostream &os, bool print_all)
	This function outputs all HGRID data. More...

Mdouble	getHGridCurrentMaxRelativeDisplacement ()

Mdouble	getHGridTotalCurrentMaxRelativeDisplacement ()

void	setHGridUpdateEachTimeStep (bool updateEachTimeStep)

bool	getHGridUpdateEachTimeStep ()

void	setHGridMaxLevels (int HGridMaxLevels)

int	getHGridMaxLevels ()

HGridMethod	getHGridMethod ()

void	setHGridMethod (HGridMethod hGridMethod)

HGridDistribution	getHGridDistribution ()

void	setHGridDistribution (HGridDistribution hGridDistribution)

Mdouble	getHGridCellOverSizeRatio ()

void	setHGridCellOverSizeRatio (Mdouble cellOverSizeRatio)

Public Member Functions inherited from MD
void	constructor ()
	A public constructor, which sets defaults so the problem can be solved off the shelf. More...

	MD ()

	MD (STD_save &other)

virtual	~MD ()

void	info ()
	Set up a virtual info this will be provided from the inhertiance. More...

void	solve ()
	The work horse of the code. More...

void	solve (unsigned int argc, char *argv[])
	Read arguments before solving. More...

void	solveWithMDCLR ()
	Tries to solve the problem using MDCLR. More...

Mdouble	get_t ()
	Access function for the time. More...

void	set_t (Mdouble new_t)
	Access function for the time. More...

int	get_NSpecies ()
	Allows the number of Species to be accessed. More...

std::vector< CSpecies > &	get_Species (void)
	Allows the species to be copied. More...

CSpecies *	get_Species (int i)
	Allows the species to be accessed. More...

CSpecies *	get_MixedSpecies (int i, int j)
	Allows the mixed species to be accessed. More...

void	set_MixedSpecies (int i, int j, CSpecies &S)
	Allows the mixed species to be set. More...

void	set_tmax (Mdouble new_tmax)
	Allows the upper time limit to be changed. More...

Mdouble	get_tmax ()
	Allows the upper time limit to be accessed. More...

ParticleHandler &	getParticleHandler ()

WallHandler &	getWallHandler ()

BoundaryHandler &	getBoundaryHandler ()

void	set_savecount (int new_)
	Allows the number of time steps between saves to be changed, see also set_number_of_saves. More...

void	set_save_count_all (int new_)

void	set_save_count_data (int new_)

void	set_save_count_ene (int new_)

void	set_save_count_stat (int new_)

void	set_save_count_fstat (int new_)

int	get_savecount ()
	Allows the number of time steps between saves to be accessed. More...

int	get_save_count ()

int	get_save_count_data ()

int	get_save_count_ene ()

int	get_save_count_stat ()

int	get_save_count_fstat ()

void	set_do_stat_always (bool new_)
	Sets how often the data is saved using the number of saves wanted, tmax, and dt. See also set_savecount. More...

void	set_number_of_saves (Mdouble N)

void	set_number_of_saves_all (Mdouble N)

void	set_number_of_saves_data (Mdouble N)

void	set_number_of_saves_ene (Mdouble N)

void	set_number_of_saves_stat (Mdouble N)

void	set_number_of_saves_fstat (Mdouble N)

void	set_plastic_k1_k2max_kc_depth (Mdouble k1_, Mdouble k2max_, Mdouble kc_, Mdouble depth_, unsigned int indSpecies=0)
	Allows the plastic constants to be changed. More...

void	set_k1 (Mdouble new_, unsigned int indSpecies=0)

void	set_k2max (Mdouble new_, unsigned int indSpecies=0)

void	set_kc (Mdouble new_, unsigned int indSpecies=0)

void	set_depth (Mdouble new_, unsigned int indSpecies=0)

Mdouble	get_k1 (unsigned int indSpecies=0)
	Allows the plastic constants to be accessed. More...

Mdouble	get_k2max (unsigned int indSpecies=0)

Mdouble	get_kc (unsigned int indSpecies=0)

Mdouble	get_depth (unsigned int indSpecies=0)

Mdouble	get_plastic_dt (Mdouble mass, unsigned int indSpecies=0)

void	set_k (Mdouble new_, unsigned int indSpecies=0)
	Allows the spring constant to be changed. More...

Mdouble	get_k (int indSpecies=0)
	Allows the spring constant to be accessed. More...

void	set_kt (Mdouble new_, unsigned int indSpecies=0)
	Allows the spring constant to be changed. More...

Mdouble	get_kt (int indSpecies=0)
	Allows the spring constant to be accessed. More...

void	set_krolling (Mdouble new_, unsigned int indSpecies=0)
	Allows the spring constant to be changed. More...

Mdouble	get_krolling (int indSpecies=0)
	Allows the spring constant to be accessed. More...

void	set_ktorsion (Mdouble new_, unsigned int indSpecies=0)
	Allows the spring constant to be changed. More...

Mdouble	get_ktorsion (int indSpecies=0)
	Allows the spring constant to be accessed. More...

void	set_rho (Mdouble new_, unsigned int indSpecies=0)
	Allows the density to be changed. More...

Mdouble	get_rho (int indSpecies=0)
	Allows the density to be accessed. More...

void	set_dispt (Mdouble new_, unsigned int indSpecies=0)
	Allows the tangential viscosity to be changed. More...

Mdouble	get_dispt (unsigned int indSpecies=0)
	Allows the tangential viscosity to be accessed. More...

void	set_disprolling (Mdouble new_, unsigned int indSpecies=0)
	Allows the tangential viscosity to be changed. More...

Mdouble	get_disprolling (unsigned int indSpecies=0)
	Allows the tangential viscosity to be accessed. More...

void	set_disptorsion (Mdouble new_, unsigned int indSpecies=0)
	Allows the tangential viscosity to be changed. More...

Mdouble	get_disptorsion (unsigned int indSpecies=0)
	Allows the tangential viscosity to be accessed. More...

void	set_disp (Mdouble new_, unsigned int indSpecies=0)
	Allows the normal dissipation to be changed. More...

Mdouble	get_disp (unsigned int indSpecies=0)
	Allows the normal dissipation to be accessed. More...

void	set_dissipation (Mdouble new_, unsigned int indSpecies=0)
	Allows the normal dissipation to be changed. More...

Mdouble	get_dissipation (unsigned int indSpecies=0)
	Allows the normal dissipation to be accessed. More...

void	set_mu (Mdouble new_, unsigned int indSpecies=0)
	Allows the Coulomb friction coefficient to be changed. More...

Mdouble	get_mu (unsigned int indSpecies=0)
	Allows the Coulomb friction coefficient to be accessed. More...

void	set_murolling (Mdouble new_, unsigned int indSpecies=0)
	Allows the Coulomb friction coefficient to be changed. More...

Mdouble	get_murolling (unsigned int indSpecies=0)
	Allows the Coulomb friction coefficient to be accessed. More...

void	set_mutorsion (Mdouble new_, unsigned int indSpecies=0)
	Allows the Coulomb friction coefficient to be changed. More...

Mdouble	get_mutorsion (unsigned int indSpecies=0)
	Allows the Coulomb friction coefficient to be accessed. More...

void	set_rotation (bool new_)

bool	get_rotation ()

void	set_dim_particle (int new_, unsigned int indSpecies=0)
	Allows the dimension of the particle (f.e. for mass) to be changed. More...

int	get_dim_particle (unsigned int indSpecies=0)
	Allows the dimension of the particle (f.e. for mass) to be accessed. More...

bool	get_save_data_data ()
	Returns the data counter. More...

bool	get_save_data_ene ()

bool	get_save_data_fstat ()

bool	get_save_data_stat ()

bool	get_do_stat_always ()

void	set_k_and_restitution_coefficient (Mdouble k_, Mdouble eps, Mdouble mass, unsigned int indSpecies=0)
	Sets k, disp such that it matches a given tc and eps for a collision of two copies of P. More...

void	set_collision_time_and_restitution_coefficient (Mdouble tc, Mdouble eps, Mdouble mass, unsigned int indSpecies=0)
	Sets k, disp such that it matches a given tc and eps for a collision of two copies of P. More...

void	set_collision_time_and_restitution_coefficient (Mdouble tc, Mdouble eps, Mdouble mass1, Mdouble mass2, unsigned int indSpecies=0)
	Set k, disp such that is matches a given tc and eps for a collision of two different masses. More...

void	set_collision_time_and_normal_and_tangential_restitution_coefficient (Mdouble tc, Mdouble eps, Mdouble beta, Mdouble mass1, Mdouble mass2, unsigned int indSpecies=0)
	See CSpecies::set_collision_time_and_normal_and_tangential_restitution_coefficient. More...

void	set_collision_time_and_normal_and_tangential_restitution_coefficient_nodispt (Mdouble tc, Mdouble eps, Mdouble beta, Mdouble mass1, Mdouble mass2, unsigned int indSpecies=0)
	See CSpecies::set_collision_time_and_normal_and_tangential_restitution_coefficient. More...

Mdouble	get_collision_time (Mdouble mass, unsigned int indSpecies=0)
	Calculates collision time for two copies of a particle of given disp, k, mass. More...

Mdouble	get_restitution_coefficient (Mdouble mass, unsigned int indSpecies=0)
	Calculates restitution coefficient for two copies of given disp, k, mass. More...

Mdouble	get_xmin ()
	Get xmin. More...

Mdouble	get_xmax ()
	Get xmax. More...

Mdouble	get_ymin ()
	Gets ymin. More...

Mdouble	get_ymax ()
	Gets ymax. More...

Mdouble	get_zmin ()
	Gets zmin. More...

Mdouble	get_zmax ()
	Gets zmax. More...

void	set_xmin (Mdouble new_xmin)
	Sets xmin and walls, assuming the standard definition of walls as in the default constructor. More...

void	set_ymin (Mdouble new_ymin)

void	set_zmin (Mdouble new_zmin)
	Sets ymin and walls, assuming the standard definition of walls as in the default constructor. More...

void	set_xmax (Mdouble new_xmax)
	Sets xmax and walls, assuming the standard definition of walls as in the default constructor. More...

void	set_ymax (Mdouble new_ymax)
	Sets ymax and walls, assuming the standard definition of walls as in the default constructor. More...

void	set_zmax (Mdouble new_zmax)
	Sets ymax and walls, assuming the standard definition of walls as in the default constructor. More...

void	set_dt (Mdouble new_dt)
	Allows the time step dt to be changed. More...

Mdouble	get_dt ()
	Allows the time step dt to be accessed. More...

void	set_name (const char *name)
	Sets the name of the problem, used for the same data files. More...

void	set_xballs_colour_mode (int new_cmode)
	Set the xball output mode. More...

void	set_xballs_cmode (int new_cmode)

int	get_xballs_cmode ()

void	set_xballs_vector_scale (double new_vscale)
	Set the scale of vectors in xballs. More...

double	get_xballs_vscale ()

void	set_xballs_additional_arguments (std::string new_)
	Set the additional arguments for xballs. More...

std::string	get_xballs_additional_arguments ()

void	set_xballs_scale (Mdouble new_scale)
	Set the scale of the xballs problem. The default is fit to screen. More...

double	get_xballs_scale ()

void	set_gravity (Vec3D new_gravity)
	Allows the gravitational acceleration to be changed. More...

Vec3D	get_gravity ()
	Allows the gravitational acceleration to be accessed. More...

void	set_dim (int new_dim)
	Allows the dimension of the simulation to be changed. More...

int	get_dim ()
	Allows the dimension of the simulation to be accessed. More...

int	get_restart_version ()
	Gets restart_version. More...

void	set_restart_version (int new_)
	Sets restart_version. More...

bool	get_restarted ()
	Gets restarted. More...

Mdouble	get_max_radius ()
	Sets restarted. More...

void	set_restarted (bool new_)

bool	get_append ()
	Gets restarted. More...

void	set_append (bool new_)
	Sets restarted. More...

Mdouble	get_ene_ela ()
	Gets ene_ela. More...

void	set_ene_ela (Mdouble new_)
	Sets ene_ela. More...

void	add_ene_ela (Mdouble new_)
	Sets ene_ela. More...

void	Remove_Particle (int IP)
	This function removes partice IP from the vector of particles by moving the last particle in the vector to the position if IP Also it checks if the moved Particle has any tangentialsspring-information, which needs to be moved to a different particle, because tangential spring information always needs to be stored in the real particle with highest particle index. More...

Mdouble	get_Mass_from_Radius (Mdouble radius, int indSpecies=0)

Mdouble	get_maximum_velocity (BaseParticle &P)
	Calculates the maximum velocity allowed for a collision of two copies of P (for higher velocities particles could pass through each other) More...

virtual BaseParticle *	getSmallestParticle ()

virtual BaseParticle *	getLargestParticle ()

virtual void	removeParticle (int iP)

Mdouble	get_maximum_velocity ()

void	set_dt_by_mass (Mdouble mass)
	Sets dt to 1/50-th of the collision time for two particles of mass P. More...

void	set_dt (BaseParticle &P)
	Sets dt to 1/50-th of the collision time for two copies of P. More...

void	set_dt ()
	Sets dt to 1/50-th of the smallest possible collision time. More...

virtual void	setup_particles_initial_conditions ()
	This function allows the initial conditions of the particles to be set, by default locations is random. More...

virtual void	create_xballs_script ()
	This creates a scipt which can be used to load the xballs problem to display the data just generated. More...

virtual double	getInfo (BaseParticle &P)
	Allows the user to set what is written into the info column in the data file. By default is store the Species ID number. More...

virtual void	save_restart_data ()
	Stores all MD data. More...

int	load_restart_data ()
	Loads all MD data. More...

int	load_restart_data (std::string filename)

void	statistics_from_restart_data (const char *name)
	Loads all MD data and plots statistics for all timesteps in the .data file. More...

virtual void	write_v1 (std::ostream &os)
	Writes all MD data. More...

virtual void	read_v1 (std::istream &is)
	Reads all MD data. More...

virtual void	read_v2 (std::istream &is)

bool	load_from_data_file (const char *filename, unsigned int format=0)
	This allows particle data to be reloaded from data files. More...

bool	load_par_ini_file (const char *filename)
	allows the user to read par.ini files (useful to read MDCLR files) More...

bool	read_next_from_data_file (unsigned int format=0)
	by default format do not pass an argument; only specify format if you have to read a special format (f.e. dim=2, but format=14 (3d format)) More...

int	read_dim_from_data_file ()

bool	find_next_data_file (Mdouble tmin, bool verbose=true)

void	add_Species (CSpecies &S)

void	add_Species (void)

void	set_format (int new_)

int	get_format ()

int	readArguments (unsigned int argc, char *argv[])
	Can interpret main function input arguments that are passed by the driver codes. More...

Public Member Functions inherited from STD_save
	STD_save ()
	Default constructor: sets the counter to 0 (i.e. no number will be included). More...

	STD_save (STD_save &other)
	Copy constructor. More...

void	constructor ()

void	inc_counter_in_file ()
	Increament the counter value stored in the file_counter by 1 and store the new value. More...

int	read_run_num_from_file ()
	Read rom the counter file the counter. More...

void	set_counter_from_file ()
	Sets the counter based on the current number stored in the counter file. More...

void	save_info_to_disk ()
	Saves the information generated by info to disk in a file. More...

void	set_counter (int new_counter)
	This set the counter, overriding the defaults. More...

int	get_counter ()
	This returns the current value of the counter. More...

bool	FileExists (std::string strFilename)
	Function to check if a file exists, is used to check if a run has already need done. More...

void	auto_number ()

std::vector< int >	get_numbers (int size_x, int size_y)
	This turns a counter into two indexs for doing parmater studies. The indexs run from 1:size_x and 1:size_y where as the study number starts at 0. More...

int	launch_new (const char *name, bool quick=false)
	This launch a code from within this code. Please pass the name of the code to run. More...

void	set_name (const char *name)
	Sets the name of the problem, used for the same data files. More...

std::string	get_name ()
	Allows the problem_name to be accessed. More...

std::fstream &	get_data_file ()
	Allows the problem_name to be accessed. More...

std::fstream &	get_stat_file ()
	Allows the problem_name to be accessed. More...

std::fstream &	get_fstat_file ()
	Allows the problem_name to be accessed. More...

std::fstream &	get_ene_file ()
	Allows the problem_name to be accessed. More...

void	set_fstat_filename (std::string filename)

void	set_data_filename (std::string filename)

void	set_stat_filename (std::string filename)

void	set_ene_filename (std::string filename)

void	set_fstat_filename ()

void	set_data_filename ()

void	set_stat_filename ()

void	set_ene_filename ()

std::string	get_fstat_filename ()

std::string	get_data_filename ()

std::string	get_stat_filename ()

std::string	get_ene_filename ()

void	set_step_size (unsigned int new_)

unsigned int	get_step_size ()

void	set_options_fstat (unsigned int new_)
	set and get for file options More...

unsigned int	get_options_fstat (void)

void	set_options_data (unsigned int new_)

unsigned int	get_options_data (void)

void	set_options_stat (unsigned int new_)

unsigned int	get_options_stat (void)

void	set_options_restart (unsigned int new_)

unsigned int	get_options_restart (void)

void	set_options_ene (unsigned int new_)

unsigned int	get_options_ene (void)

bool	open_file (std::fstream &file, std::string filename, unsigned int options, std::fstream::openmode mode)

bool	open_fstat_file (std::fstream::openmode mode=std::fstream::out)

bool	open_data_file (std::fstream::openmode mode=std::fstream::out)

bool	open_stat_file (std::fstream::openmode mode=std::fstream::out)

bool	open_ene_file (std::fstream::openmode mode=std::fstream::out)

bool	open_counted_file (std::fstream &file, std::string filenameNoCount, std::fstream::openmode mode)
	opens file needed if data is written in multiple files More...

bool	increase_counter_fstat (std::fstream::openmode mode)

bool	increase_counter_data (std::fstream::openmode mode)

bool	increase_counter_stat (std::fstream::openmode mode)

bool	increase_counter_ene (std::fstream::openmode mode)

void	set_file_counter (int new_)

int	get_file_counter ()

Public Attributes
HGrid *	grid

Public Attributes inherited from MD
RNG	random

Protected Member Functions
void	InitBroadPhase ()
	This sets up the parameters required for the contact model. More...

void	HGRID_InsertParticleToHgrid (BaseParticle *obj)
	Inserts a single Particle to current grid. More...

void	broad_phase (BaseParticle *i)
	This makes the board_phase of contact point at the HGRID code. More...

virtual void	CheckObjAgainstGrid (HGrid grid, BaseParticle obj)=0
	This is a purly virtual function that checks if an object is in the grid, this code is again dim dependent so purly virtual at this stage. More...

virtual bool	TestObject (BaseParticle pI, BaseParticle pJ)
	criterium for inserting a particle (returns false, if particles overlap;) More...

void	HGRID_update_move (BaseParticle *iP, Mdouble move)

void	HGRID_actions_before_integration ()

void	HGRID_actions_after_integration ()

int	readNextArgument (unsigned int &i, unsigned int argc, char *argv[])

Protected Member Functions inherited from MD
virtual void	compute_all_forces ()
	This does the force computation. More...

virtual void	compute_internal_forces (BaseParticle *i)
	Computes the forces between particles (internal in the sence that the sum over all these forces is zero i.e. fully modelled forces) More...

CTangentialSpring *	getTangentialSpring (BaseParticle PI, BaseParticle PJ, BaseParticle *PJreal)

CTangentialSpring *	getTangentialSpringWall (BaseParticle *pI, int w)

virtual void	compute_internal_forces (BaseParticle P1, BaseParticle P2)
	Computes the forces between particles (internal in the sence that the sum over all these forces is zero i.e. fully modelled forces) More...

void	compute_plastic_internal_forces (BaseParticle P1, BaseParticle P2)
	Computes plastic forces between particles. More...

virtual void	compute_external_forces (BaseParticle *PI)
	This is were the computation of external forces takes place (e.g. gravity) More...

virtual void	compute_walls (BaseParticle *PI)
	This is were the walls are. More...

Mdouble	computeShortRangeForceWithWall (BaseParticle pI, int wall, CSpecies pSpecies, Mdouble dist)

Mdouble	computeShortRangeForceWithParticle (BaseParticle PI, BaseParticle PJ, BaseParticle PJreal, CSpecies pSpecies, Mdouble dist)

virtual void	actions_before_time_loop ()
	This is actions before the start of the main time loop. More...

virtual void	HGRID_InsertParticleToHgrid (BaseParticle *obj UNUSED)
	This is action before the time step is started. More...

virtual void	HGRID_UpdateParticleInHgrid (BaseParticle *obj UNUSED)

virtual void	HGRID_RemoveParticleFromHgrid (BaseParticle *obj UNUSED)

virtual bool	get_HGRID_UpdateEachTimeStep ()

virtual void	actions_before_time_step ()
	This is action before the time step is started. More...

virtual void	actions_after_solve ()
	This is actions at the end of the code, but before the files are closed. More...

virtual void	actions_after_time_step ()
	This is action after the time step is finished. More...

virtual void	output_xballs_data ()
	Output xball data for Particle i. More...

virtual void	output_xballs_data_particle (int i)
	This function outputs the location and velocity of the particle in a format the xballs progream can read. More...

virtual void	start_ene ()
	Functions for ene file. More...

virtual void	fstat_header ()

virtual void	output_ene ()
	This function outputs statistical data - The default is to compute the rotational kinetic engergy, linear kinetic energy, and the centre of mass. More...

virtual void	initialize_statistics ()
	Functions for statistics. More...

virtual void	output_statistics ()

virtual void	gather_statistics_collision (int index1 UNUSED, int index2 UNUSED, Vec3D Contact UNUSED, Mdouble delta UNUSED, Mdouble ctheta UNUSED, Mdouble fdotn UNUSED, Mdouble fdott UNUSED, Vec3D P1_P2_normal_ UNUSED, Vec3D P1_P2_tangential UNUSED)

virtual void	process_statistics (bool usethese UNUSED)

virtual void	finish_statistics ()

virtual void	set_initial_pressures_for_pressure_controlled_walls ()

virtual void	do_integration_before_force_computation (BaseParticle *pI)
	This is were the integration is done. More...

virtual void	checkInteractionWithBoundaries ()

virtual void	do_integration_after_force_computation (BaseParticle *pI)
	This is were the integration is done. More...

void	set_FixedParticles (unsigned int n)

void	initialize_tangential_springs ()

void	compute_particle_masses ()
	Computes the mass of each particle. More...

virtual void	cout_time ()
	std::couts time More...

virtual bool	continue_solve ()

void	reset_DeltaMax ()
	sets the history parameter DeltaMax of all particles to zero More...

void	reset_TangentialSprings ()
	sets the history parameter TangentialSprings of all particles to zero More...

Private Attributes
HGridMethod	hGridMethod_

HGridDistribution	hGridDistribution_

Mdouble	currentMaxRelativeDisplacement_

Mdouble	totalCurrentMaxRelativeDisplacement_

bool	updateEachTimeStep_

int	NUM_BUCKETS

int	hGridMaxLevels_

Mdouble	cellOverSizeRatio_

Additional Inherited Members
Protected Attributes inherited from MD
std::vector< CSpecies >	Species
	These are the particle parameters like dissipation etc. More...

Protected Attributes inherited from STD_save
std::stringstream	problem_name
	Stores the problem_name. More...

std::stringstream	data_filename
	These store the save file names, by default they are derived from problem_name. More...

std::stringstream	stat_filename

std::stringstream	fstat_filename

std::stringstream	ene_filename

std::fstream	data_file
	Stream used for data files. More...

std::fstream	stat_file

std::fstream	fstat_file

std::fstream	ene_file

unsigned int	options_fstat
	Indicators if files are created or not 0: file will not be created 1: file will be written in one file 2: file will be written in multiple files. More...

unsigned int	options_data

unsigned int	options_stat

unsigned int	options_ene

unsigned int	options_restart

unsigned int	file_counter
	Counter needed if file will be written in multiple files. More...

unsigned int	step_size

Detailed Description

This is the base class for both HGRID_2D and HGRID_3D.

Note the actually abstrate grid is defined in the case Grid defined below

Todo:: Remove the dimension out of this class by templating and use of for loops for the check cells part

Definition at line 43 of file HGRID_base.h.

Constructor & Destructor Documentation

HGRID_base::HGRID_base ( )

This is the default constructor. All it does is set senible defaults.

Definition at line 28 of file HGRID_base.cc.

References constructor().

 {
     constructor();
     #ifdef CONSTUCTOR_OUTPUT
         std::cerr << "HGRID_base() finished"<<std::endl;
     #endif
 }

HGRID_base::~HGRID_base ( )

This is the default destructor.

Definition at line 36 of file HGRID_base.cc.

References grid.

                         {   
     if (grid) { delete grid; grid=NULL; } 
 }

HGRID_base::HGRID_base ( MD & other )

Copy-constructor for creates an HGRID problem from an existing MD problem.

Definition at line 40 of file HGRID_base.cc.

References constructor().

                                 : MD(other)
 {
     constructor();
     #ifdef CONSTUCTOR_OUTPUT
         std::cerr << "HGRID_base(MD& other) finished " << std::endl;
     #endif
 }

Member Function Documentation

void HGRID_base::broad_phase ( BaseParticle * i )

inlineprotectedvirtual

This makes the board_phase of contact point at the HGRID code.

Reimplemented from MD.

Definition at line 113 of file HGRID_base.h.

References CheckObjAgainstGrid(), and grid.

113 {CheckObjAgainstGrid(grid, i);}

HGRID_base::CheckObjAgainstGrid

virtual void CheckObjAgainstGrid(HGrid *grid, BaseParticle *obj)=0

This is a purly virtual function that checks if an object is in the grid, this code is again dim depe...

HGRID_base::grid

HGrid * grid

Definition: HGRID_base.h:131

virtual void HGRID_base::CheckObjAgainstGrid	(	HGrid *	grid,
		BaseParticle *	obj
	)

protectedpure virtual

This is a purly virtual function that checks if an object is in the grid, this code is again dim dependent so purly virtual at this stage.

Implemented in HGRID_3D, and HGRID_2D.

Referenced by broad_phase().

void HGRID_base::constructor ( )

This is the actually constructor it is called do both constructors above.

This is the actually constructor for this problem. It is defined here because it is called by both the copy constructor and normal constructor.

Set senible default values for all the required parameters

Definition at line 49 of file HGRID_base.cc.

References cellOverSizeRatio_, EXPONENTIAL, grid, hGridMaxLevels_, NUM_BUCKETS, setHGridDistribution(), setHGridMethod(), setHGridUpdateEachTimeStep(), and TOPDOWN.

Referenced by HGRID_base().

 {
     NUM_BUCKETS=250000;
     hGridMaxLevels_=3;
     grid = NULL;
     
     cellOverSizeRatio_=1.0;
     
     setHGridUpdateEachTimeStep(true);
     setHGridDistribution(EXPONENTIAL);
     setHGridMethod(TOPDOWN);
     
 }

Mdouble HGRID_base::getHGridCellOverSizeRatio ( )

Definition at line 318 of file HGRID_base.cc.

References cellOverSizeRatio_.

 {
     return cellOverSizeRatio_;
 }

Mdouble HGRID_base::getHGridCurrentMaxRelativeDisplacement ( )

Definition at line 127 of file HGRID_base.cc.

References currentMaxRelativeDisplacement_.

 {
     return currentMaxRelativeDisplacement_;
 }

HGridDistribution HGRID_base::getHGridDistribution ( )

Definition at line 308 of file HGRID_base.cc.

References hGridDistribution_.

Referenced by InitBroadPhase().

 {
     return hGridDistribution_;
 }

int HGRID_base::getHGridMaxLevels ( )

Definition at line 340 of file HGRID_base.cc.

References hGridMaxLevels_.

 {
     return hGridMaxLevels_;
 }

HGridMethod HGRID_base::getHGridMethod ( )

Definition at line 298 of file HGRID_base.cc.

References hGridMethod_.

Referenced by HGRID_2D::CheckObjAgainstGrid(), and HGRID_3D::CheckObjAgainstGrid().

 {
     return hGridMethod_;
 }

Mdouble HGRID_base::getHGridTotalCurrentMaxRelativeDisplacement ( )

Definition at line 132 of file HGRID_base.cc.

References totalCurrentMaxRelativeDisplacement_.

 {
     return totalCurrentMaxRelativeDisplacement_;
 }

bool HGRID_base::getHGridUpdateEachTimeStep ( )

Definition at line 142 of file HGRID_base.cc.

References updateEachTimeStep_.

Referenced by HGRID_actions_before_time_step().

                                            {
     return updateEachTimeStep_;
 }    

void HGRID_base::HGRID_actions_after_integration ( )

protectedvirtual

Reimplemented from MD.

Definition at line 272 of file HGRID_base.cc.

References currentMaxRelativeDisplacement_, and totalCurrentMaxRelativeDisplacement_.

 {
     totalCurrentMaxRelativeDisplacement_+=2.0*currentMaxRelativeDisplacement_;
 }

void HGRID_base::HGRID_actions_before_integration ( )

protectedvirtual

Reimplemented from MD.

Definition at line 267 of file HGRID_base.cc.

References currentMaxRelativeDisplacement_.

 {
     currentMaxRelativeDisplacement_=0;
 }

void HGRID_base::HGRID_actions_before_time_loop ( )

virtual

This sets up the broad phase information, has to be done at this stage becuase it requires the partcle size.

Reimplemented from MD.

Definition at line 66 of file HGRID_base.cc.

References InitBroadPhase().

Referenced by Chute::create_bottom(), and ChuteBottom::setup_particles_initial_conditions().

 {
     InitBroadPhase();
 }

void HGRID_base::HGRID_actions_before_time_step ( )

virtual

This resets all the bucket information.

This is the actions before the time step, it basically compute which cell each particle is in.

Reimplemented from MD.

Definition at line 221 of file HGRID_base.cc.

References HGrid::bucketIsChecked, cellOverSizeRatio_, BaseHandler< T >::end(), getHGridUpdateEachTimeStep(), MD::getParticleHandler(), grid, MD::HGRID_UpdateParticleInHgrid(), HGrid::NUM_BUCKETS, HGrid::objectBucket, and totalCurrentMaxRelativeDisplacement_.

Referenced by Chute::create_bottom().

 {
     static int stepsBeforeUpdate=0;
     
     for (int i=0; i<grid->NUM_BUCKETS; i++)
     {
         grid->bucketIsChecked[i]    = false;
     }
 
     if(getHGridUpdateEachTimeStep()||totalCurrentMaxRelativeDisplacement_>=cellOverSizeRatio_-1)
     {
 #ifndef ContactListHgrid
         for (int i=0; i<grid->NUM_BUCKETS; i++)
         {
             grid->objectBucket[i]       = NULL;
         }
 #endif
         totalCurrentMaxRelativeDisplacement_=0;
         for (std::vector<BaseParticle*>::iterator it = getParticleHandler().begin(); it!=getParticleHandler().end(); ++it)
         {
             HGRID_UpdateParticleInHgrid(*it);
         }
         stepsBeforeUpdate=0;
     }
     else
     {
         stepsBeforeUpdate++;
     }
 }

void HGRID_base::HGRID_InsertParticleToHgrid ( BaseParticle * obj )

protected

Inserts a single Particle to current grid.

Definition at line 214 of file HGRID_base.cc.

References grid, and HGrid::InsertParticleToHgrid().

 {
     grid->InsertParticleToHgrid(obj);
 }

void HGRID_base::HGRID_update_move	(	BaseParticle *	iP,
		Mdouble	move
	)

protectedvirtual

Reimplemented from MD.

Definition at line 258 of file HGRID_base.cc.

References HGrid::cellSizes_, currentMaxRelativeDisplacement_, BaseParticle::get_HGRID_Level(), and grid.

 {
     Mdouble currentRelativeDisplacement=move/(grid->cellSizes_[iP->get_HGRID_Level()]);
     if(currentRelativeDisplacement>currentMaxRelativeDisplacement_)
     {
         currentMaxRelativeDisplacement_=currentRelativeDisplacement;
     }
 }

void HGRID_base::InitBroadPhase ( )

protectedvirtual

This sets up the parameters required for the contact model.

This set up the Broad grid.

/todo{This is really ugly}

Reimplemented from MD.

Definition at line 147 of file HGRID_base.cc.

References HGrid::bucketIsChecked, cellOverSizeRatio_, BaseHandler< T >::end(), EXPONENTIAL, BaseParticle::get_InteractionRadius(), getHGridDistribution(), MD::getLargestParticle(), MD::getParticleHandler(), MD::getSmallestParticle(), grid, MD::HGRID_UpdateParticleInHgrid(), hGridMaxLevels_, HGrid::Initialize_inv_size(), HGrid::InsertParticleToHgrid(), LINEAR, HGrid::NUM_BUCKETS, NUM_BUCKETS, HGrid::objectBucket, HGrid::occupiedLevelsMask, and OLDHGRID.

Referenced by HGRID_actions_before_time_loop().

 {
     std::vector<double> cellSizes;
     switch(getHGridDistribution())
     {
         case LINEAR:
         {
             double minCellSize=0.99999*2.0*getSmallestParticle()->get_InteractionRadius()*cellOverSizeRatio_;
             double maxCellSize=1.00001*2.0*getLargestParticle()->get_InteractionRadius()*cellOverSizeRatio_;
             std::cout<<"HGrid: using a linear cell size distribution from "<<minCellSize<<" to "<<maxCellSize<<" over "<<hGridMaxLevels_<<" levels"<<std::endl;
             for (int i=0; i<hGridMaxLevels_; i++)
             {
                 cellSizes.push_back(minCellSize+(maxCellSize-minCellSize)*(i+1.0)/hGridMaxLevels_);
             }
             break;            
         }
         case EXPONENTIAL:
         {
             double minCellSize=0.99999*2.0*getSmallestParticle()->get_InteractionRadius()*cellOverSizeRatio_;
             double maxCellSize=1.00001*2.0*getLargestParticle()->get_InteractionRadius()*cellOverSizeRatio_;
             std::cout<<"HGrid: using an exponential cell size distribution from "<<minCellSize<<" to "<<maxCellSize<<" over "<<hGridMaxLevels_<<" levels"<<std::endl;
             for (int i=0; i<hGridMaxLevels_; i++)
             {
                 cellSizes.push_back(minCellSize*pow(maxCellSize/minCellSize,(i+1.0)/hGridMaxLevels_));
             }
             break;
         }
         case OLDHGRID:
         {
             double minCellSize=2.0*getSmallestParticle()->get_InteractionRadius()*cellOverSizeRatio_;
             for (int i=0; i<hGridMaxLevels_; i++)
             {
                 cellSizes.push_back(minCellSize*pow(2,i));
             }
             break;            
         }
         
     }
 
     //Create grid object
     if (grid!=NULL)
     {
         delete grid;
     }
     grid = new HGrid(NUM_BUCKETS, cellOverSizeRatio_, cellSizes);
     
     grid->occupiedLevelsMask = 0;
     
     grid->Initialize_inv_size();
 
     //New steps in initbroad_phase is to not only Insert the Particles in the grid but also update them
     for (int i=0; i<grid->NUM_BUCKETS; i++)
     {
         grid->objectBucket[i]       = NULL;
         grid->bucketIsChecked[i]    = false;
     }
     
     for (std::vector<BaseParticle*>::iterator it = getParticleHandler().begin(); it!=getParticleHandler().end(); ++it)
     {
         grid->InsertParticleToHgrid(*it);
         (*it)->set_HGRID_x(9999);
         HGRID_UpdateParticleInHgrid(*it);
     }
 
 }

void HGRID_base::print	(	std::ostream &	os,
		bool	print_all = `false`
	)

virtual

This function outputs all HGRID data.

Reimplemented from MD.

Definition at line 121 of file HGRID_base.cc.

References cellOverSizeRatio_, hGridMaxLevels_, NUM_BUCKETS, and MD::print().

Referenced by Chute::print().

 {
     MD::print(os,print_all);
     os << " NUM_BUCKETS:" << NUM_BUCKETS << ", hGridMaxLevels:" << hGridMaxLevels_ <<", cellOverSizeRatio:" << cellOverSizeRatio_<<std::endl;
 }

void HGRID_base::read ( std::istream & is )

virtual

This function reads all HGRID data.

Reimplemented from MD.

Definition at line 99 of file HGRID_base.cc.

References cellOverSizeRatio_, getLineFromStringStream(), hGridMaxLevels_, NUM_BUCKETS, and MD::read().

Referenced by Chute::read().

 { 
     MD::read(is); 
 
     std::stringstream line (std::stringstream::in | std::stringstream::out);
     getLineFromStringStream(is,line);
 
     std::string dummy;
     line>> dummy >> NUM_BUCKETS 
         >> dummy >> hGridMaxLevels_
         >> dummy >> cellOverSizeRatio_;
 
 }

int HGRID_base::readNextArgument	(	unsigned int &	i,
		unsigned int	argc,
		char *	argv[]
	)

protectedvirtual

Reimplemented from MD.

Definition at line 277 of file HGRID_base.cc.

References cellOverSizeRatio_, hGridMaxLevels_, NUM_BUCKETS, and MD::readNextArgument().

Referenced by Chute::readNextArgument().

 {
     if (!strcmp(argv[i],"-NUM_BUCKETS"))
     {
         NUM_BUCKETS = atoi(argv[i+1]);
     }
     else if (!strcmp(argv[i],"-hGridMaxLevels"))
     {
         hGridMaxLevels_ = atoi(argv[i+1]);
     }
     else if (!strcmp(argv[i],"-cellOverSizeRatio"))
     {
         cellOverSizeRatio_ = atof(argv[i+1]);
     }
     else
     {
         return MD::readNextArgument(i, argc, argv); //if argv[i] is not found, check the commands in HGRID_3D
     }
     return true; //returns true if argv[i] is found
 }

void HGRID_base::set_HGRID_num_buckets ( unsigned int new_num_buckets )

This sets the number of buckets for the HGRID.

Definition at line 71 of file HGRID_base.cc.

References NUM_BUCKETS.

Referenced by set_HGRID_num_buckets_to_power().

 {
     if (new_num_buckets>0)
     {
         NUM_BUCKETS=new_num_buckets;
     }
     else
     {
         std::cerr << "Error in set_HGRID_num_buckets" << std::endl;
         exit(-1);
     }
 }

void HGRID_base::set_HGRID_num_buckets_to_power ( )

set number of buckets to the smallest power of two bigger than the number of particles

Definition at line 84 of file HGRID_base.cc.

References MD::getParticleHandler().

Referenced by ChuteBottom::setup_particles_initial_conditions().

 {
     set_HGRID_num_buckets_to_power(getParticleHandler().getNumberOfObjects());
 }

void HGRID_base::set_HGRID_num_buckets_to_power ( unsigned int N )

set number of buckets to the smallest power of two bigger than N

Definition at line 89 of file HGRID_base.cc.

References NUM_BUCKETS, and set_HGRID_num_buckets().

 {
     unsigned int NUM_BUCKETS = 32;
     while (NUM_BUCKETS<2*N)
     {
         NUM_BUCKETS *= 2;
     }
     set_HGRID_num_buckets(NUM_BUCKETS);
 }

void HGRID_base::setHGridCellOverSizeRatio ( Mdouble cellOverSizeRatio )

Definition at line 323 of file HGRID_base.cc.

References cellOverSizeRatio_.

 {
     cellOverSizeRatio_=cellOverSizeRatio;
 }

void HGRID_base::setHGridDistribution ( HGridDistribution hGridDistribution )

Definition at line 313 of file HGRID_base.cc.

References hGridDistribution_.

Referenced by constructor().

 {
     hGridDistribution_=hGridDistribution;
 }

void HGRID_base::setHGridMaxLevels ( int HGridMaxLevels )

Definition at line 328 of file HGRID_base.cc.

References hGridMaxLevels_.

Referenced by ChuteBottom::setup_particles_initial_conditions().

 {
     if (hGridMaxLevels>0)
     {
         hGridMaxLevels_=hGridMaxLevels;
     }
     else
     {
         std::cout<<"Error in void HGRID_base::set_HGridMaxLevel(int hGridMaxLevels), hGridMaxLevels should be strictly positive, while it is now "<<hGridMaxLevels<<std::endl;
     }
 }

void HGRID_base::setHGridMethod ( HGridMethod hGridMethod )

Definition at line 303 of file HGRID_base.cc.

References hGridMethod_.

Referenced by constructor().

 {
     hGridMethod_=hGridMethod;
 }

void HGRID_base::setHGridUpdateEachTimeStep ( bool updateEachTimeStep )

Definition at line 137 of file HGRID_base.cc.

References updateEachTimeStep_.

Referenced by constructor().

 {
     updateEachTimeStep_=updateEachTimeStep;
 }

bool HGRID_base::TestObject	(	BaseParticle *	pI,
		BaseParticle *	pJ
	)

protectedvirtual

criterium for inserting a particle (returns false, if particles overlap;)

Definition at line 251 of file HGRID_base.cc.

References BaseParticle::get_Index(), BaseParticle::get_InteractionRadius(), BaseParticle::get_Position(), and sqr.

Referenced by HGRID_2D::TestCell(), and HGRID_3D::TestCell().

 {
     //PI==PJ check is required because this function is called for all possible close Particle combination (even itself)
     return pI->get_Index()==pJ->get_Index() || GetDistance2(pI->get_Position(),pJ->get_Position())>=sqr(pI->get_InteractionRadius()+pJ->get_InteractionRadius());
 }

void HGRID_base::write ( std::ostream & os )

virtual

This function writes all HGRID data.

Reimplemented from MD.

Definition at line 113 of file HGRID_base.cc.

References cellOverSizeRatio_, hGridMaxLevels_, NUM_BUCKETS, and MD::write().

Referenced by Chute::write().

 { 
     MD::write(os); 
     os  << "NUM_BUCKETS " << NUM_BUCKETS << " "
         << "hGridMaxLevels " << hGridMaxLevels_ << " "
         << "cellOverSizeRatio " << cellOverSizeRatio_ << std::endl;
 }