MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Chute.h File Reference
#include "Mercury3D.h"

Go to the source code of this file.

Classes

class  Chute
 Creates chutes with different bottoms. Inherits from Mercury3D (-> MercuryBase -> DPMBase). More...
 

Enumerations

enum  RoughBottomType { MONOLAYER_ORDERED, MONOLAYER_DISORDERED, MULTILAYER, FLAT }
 enum for determining the type of rough bottom (if any) of the chute. Either of the enum options can be assigned to the roughBottomType_ data member using Chute::setRoughBottomType(). The options are as follows: More...
 

Enumeration Type Documentation

enum for determining the type of rough bottom (if any) of the chute. Either of the enum options can be assigned to the roughBottomType_ data member using Chute::setRoughBottomType(). The options are as follows:

  • MONOLAYER_ORDERED: Bottom will be a rectangularly ordered monolayer of particles
  • MONOLAYER_DISORDERED: Bottom will be a disordered monolayer of particles
  • MULTILAYER: Bottom will be a multilayer of particles
  • FLAT: Flat bottom (not rough) See also the documentation of Chute::createBottom().
Todo:

consider converting to an enum class.

consider changing to just 'bottomType' and add 'FLAT' (or something similar) as an option so that from ALL bottom types can be chosen with just ONE enumerator IFCD: I did add FLAT, but since there are multiple users using RoughBottomType, it might be a bad idea to change the interface with BottomType. Please also check if I have forgotten places to add "FLAT" to make this a complete interface.

Enumerator
MONOLAYER_ORDERED 
MONOLAYER_DISORDERED 
MULTILAYER 
FLAT 

Definition at line 51 of file Chute.h.