deviational_particle.hpp File Reference

Code used to describe deviational particles. More...

#include <algorithm>
#include <Eigen/Dense>

Include dependency graph for deviational_particle.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	alma::D_particle
	Each object of this class represents a deviational particle in the simulation. More...

Enumerations
enum	alma::particle_sign { minus = -1, plus = 1 }
	Simple enum representing a sign.

Functions
template<typename T >
particle_sign	alma::get_particle_sign (const T &value)
	Convenience function for obtaining a particle_sign. More...

Detailed Description

Code used to describe deviational particles.

Function Documentation

get_particle_sign()

template<typename T >

particle_sign alma::get_particle_sign ( const T &  value )

inline

Convenience function for obtaining a particle_sign.

Parameters

[in]

value

- anything that can be compared to 0

Returns

a particle_sign. 0 is considered positive.