Dumux::Particles::Particle< dimWorld, ctype > Class Template Reference

a basic particle

#include <dumux/particles/particle.hh>

Inheritance diagram for Dumux::Particles::Particle< dimWorld, ctype >:

Public Types
using	CoordScalar = ctype
using	GlobalPosition = Dune::FieldVector<CoordScalar, dimWorld>

Public Member Functions
	Particle (std::size_t id, const GlobalPosition &p, bool active=true)
	Particle (std::size_t id, bool active=true)
const GlobalPosition &	position () const
std::size_t	id () const
bool	isActive () const
void	setPosition (const GlobalPosition &pos)
	set a new global position
void	move (const CoordScalar length, const GlobalPosition &direction)
	move by length in direction
void	deactivate ()
void	activate ()

Static Public Attributes
static constexpr int	coordDimension = dimWorld

Member Typedef Documentation

CoordScalar

template<int dimWorld, class ctype = double>

using Dumux::Particles::Particle< dimWorld, ctype >::CoordScalar = ctype

GlobalPosition

template<int dimWorld, class ctype = double>

using Dumux::Particles::Particle< dimWorld, ctype >::GlobalPosition = Dune::FieldVector<CoordScalar, dimWorld>

Constructor & Destructor Documentation

Particle() [1/2]

template<int dimWorld, class ctype = double>

Dumux::Particles::Particle< dimWorld, ctype >::Particle ( std::size_t id, const GlobalPosition & p, bool active = true )

inline

Particle() [2/2]

template<int dimWorld, class ctype = double>

Dumux::Particles::Particle< dimWorld, ctype >::Particle ( std::size_t id, bool active = true )

inline

Member Function Documentation

activate()

template<int dimWorld, class ctype = double>

void Dumux::Particles::Particle< dimWorld, ctype >::activate ( )

inline

deactivate()

template<int dimWorld, class ctype = double>

void Dumux::Particles::Particle< dimWorld, ctype >::deactivate ( )

inline

id()

template<int dimWorld, class ctype = double>

std::size_t Dumux::Particles::Particle< dimWorld, ctype >::id ( ) const

inline

isActive()

template<int dimWorld, class ctype = double>

bool Dumux::Particles::Particle< dimWorld, ctype >::isActive ( ) const

inline

move()

template<int dimWorld, class ctype = double>

void Dumux::Particles::Particle< dimWorld, ctype >::move ( const CoordScalar length, const GlobalPosition & direction )

inline

position()

template<int dimWorld, class ctype = double>

const GlobalPosition & Dumux::Particles::Particle< dimWorld, ctype >::position ( ) const

inline

setPosition()

template<int dimWorld, class ctype = double>

void Dumux::Particles::Particle< dimWorld, ctype >::setPosition ( const GlobalPosition & pos )

inline

Member Data Documentation

coordDimension

template<int dimWorld, class ctype = double>

int Dumux::Particles::Particle< dimWorld, ctype >::coordDimension = dimWorld

staticconstexpr

---

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

• particle.hh