NuTo
Numerics Tool
Public Member Functions | List of all members
NuTo::SubBoxHandler Class Reference

builds and handles sub boxes More...

#include <SubBoxHandler.h>

Public Member Functions

 SubBoxHandler (ParticleHandler &rSpheres, Specimen &rSpecimen, Eigen::Vector3i rDivisions)
 constructor, initializes the handler with a given number of sub box divisions More...
 
 SubBoxHandler (ParticleHandler &rSpheres, Specimen &rSpecimen, int rParticlesPerSubBox)
 constructor, initializes the handler, calculates the number of sub boxes More...
 
double GetVolume () const
 getter for specimen volume More...
 
void PrintBoxes ()
 prints all sub boxes and the particles inside of them More...
 
void VisualizeBorders (std::string rFile)
 visualizes the sub boxes More...
 
std::vector< SubBox > & GetSubBoxes ()
 getter for the sub box list More...
 
void AddSubBox (SubBox &rSubBox)
 adds a sub box to the sub box list sub box to add More...
 

Detailed Description

builds and handles sub boxes

Constructor & Destructor Documentation

NuTo::SubBoxHandler::SubBoxHandler ( ParticleHandler rSpheres,
Specimen rSpecimen,
Eigen::Vector3i  rDivisions 
)

constructor, initializes the handler with a given number of sub box divisions

Parameters
rSpheresspheres to be added to the sub boxes
rDivisionssets divs[0]*divs[1]*divs[2] sub boxes
NuTo::SubBoxHandler::SubBoxHandler ( ParticleHandler rSpheres,
Specimen rSpecimen,
int  rParticlesPerSubBox 
)

constructor, initializes the handler, calculates the number of sub boxes

Parameters
rSpheresspheres to be added to the sub boxes

Member Function Documentation

void NuTo::SubBoxHandler::AddSubBox ( SubBox rSubBox)

adds a sub box to the sub box list sub box to add

std::vector< NuTo::SubBox > & NuTo::SubBoxHandler::GetSubBoxes ( )

getter for the sub box list

double NuTo::SubBoxHandler::GetVolume ( ) const

getter for specimen volume

void NuTo::SubBoxHandler::PrintBoxes ( )

prints all sub boxes and the particles inside of them

void NuTo::SubBoxHandler::VisualizeBorders ( std::string  rFile)

visualizes the sub boxes

Parameters
rFileoutput file

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