Antioch::ParticleFlux< VectorCoeffType > Class Template Reference

Stores the incoming flux of particles. More...

#include <particle_flux.h>

Public Member Functions
	ParticleFlux ()
	ParticleFlux (const VectorCoeffType &x, const VectorCoeffType &flux)
	~ParticleFlux ()
bool	updated () const
bool	x_updated () const
const VectorCoeffType &	abscissa () const
const VectorCoeffType &	flux () const
template<typename VectorStateType >
void	set_abscissa (const VectorStateType &x)
template<typename VectorStateType >
void	set_flux (const VectorStateType &flux)
void	update_done ()
void	add_a_reaction ()
void	remove_a_reaction ()

Private Attributes
VectorCoeffType	_abscissa
VectorCoeffType	_flux
bool	_updated
bool	_x_updated
unsigned int	_n_coupled
unsigned int	_n_updated

Detailed Description

template<typename VectorCoeffType>
class Antioch::ParticleFlux< VectorCoeffType >

Stores the incoming flux of particles.

Definition at line 38 of file particle_flux.h.

Constructor & Destructor Documentation

template<typename VectorCoeffType >

Antioch::ParticleFlux< VectorCoeffType >::ParticleFlux ( )

inline

Definition at line 164 of file particle_flux.h.

                                             :
  _updated(false),
  _x_updated(false),
  _n_coupled(0),
  _n_updated(0)
  {
    return;
  }

template<typename VectorCoeffType>

Antioch::ParticleFlux< VectorCoeffType >::ParticleFlux ( const VectorCoeffType &  x, const VectorCoeffType &  flux  )

inline

Definition at line 182 of file particle_flux.h.

                                                                                                  :
  _abscissa(x),
  _flux(flux),
  _updated(true),
  _x_updated(true),
  _n_coupled(0),
  _n_updated(0)
  {
    return;
  }

template<typename VectorCoeffType >

Antioch::ParticleFlux< VectorCoeffType >::~ParticleFlux ( )

inline

Definition at line 175 of file particle_flux.h.

  {
    return;
  }

Member Function Documentation

template<typename VectorCoeffType >

const VectorCoeffType & Antioch::ParticleFlux< VectorCoeffType >::abscissa ( ) const

inline

Definition at line 86 of file particle_flux.h.

  {
     return _abscissa;
  }

template<typename VectorCoeffType >

void Antioch::ParticleFlux< VectorCoeffType >::add_a_reaction ( )

inline

Definition at line 108 of file particle_flux.h.

  {
     _n_coupled++;
     _updated = true;
     return;
  }

template<typename VectorCoeffType >

const VectorCoeffType & Antioch::ParticleFlux< VectorCoeffType >::flux ( ) const

inline

Definition at line 93 of file particle_flux.h.

  {
     return _flux;
  }

template<typename VectorCoeffType >

void Antioch::ParticleFlux< VectorCoeffType >::remove_a_reaction ( )

inline

Definition at line 100 of file particle_flux.h.

  {
     _n_coupled--;
     return;
  }

template<typename VectorCoeffType >

template<typename VectorStateType >

void Antioch::ParticleFlux< VectorCoeffType >::set_abscissa ( const VectorStateType &  x )

inline

Definition at line 146 of file particle_flux.h.

  {
     _abscissa = x;
     _updated = true;
     _x_updated = true;
  }

template<typename VectorCoeffType >

template<typename VectorStateType >

void Antioch::ParticleFlux< VectorCoeffType >::set_flux ( const VectorStateType &  flux )

inline

Definition at line 156 of file particle_flux.h.

  {
     _flux = flux;
     _updated = true;
  }

template<typename VectorCoeffType >

void Antioch::ParticleFlux< VectorCoeffType >::update_done ( )

inline

Definition at line 131 of file particle_flux.h.

  {
     _n_updated++;
     if(_n_updated == _n_coupled)
     {
        _updated   = false;
        _x_updated = false;
        _n_updated = 0;
     }
     return;
  }

template<typename VectorCoeffType >

bool Antioch::ParticleFlux< VectorCoeffType >::updated ( ) const

inline

Definition at line 117 of file particle_flux.h.

  {
     return _updated;
  }

template<typename VectorCoeffType >

bool Antioch::ParticleFlux< VectorCoeffType >::x_updated ( ) const

inline

Definition at line 124 of file particle_flux.h.

  {
     return _x_updated;
  }

Member Data Documentation

template<typename VectorCoeffType>

VectorCoeffType Antioch::ParticleFlux< VectorCoeffType >::_abscissa

private

Definition at line 41 of file particle_flux.h.

template<typename VectorCoeffType>

VectorCoeffType Antioch::ParticleFlux< VectorCoeffType >::_flux

private

Definition at line 42 of file particle_flux.h.

template<typename VectorCoeffType>

unsigned int Antioch::ParticleFlux< VectorCoeffType >::_n_coupled

private

Definition at line 45 of file particle_flux.h.

template<typename VectorCoeffType>

unsigned int Antioch::ParticleFlux< VectorCoeffType >::_n_updated

private

Definition at line 46 of file particle_flux.h.

template<typename VectorCoeffType>

bool Antioch::ParticleFlux< VectorCoeffType >::_updated

private

Definition at line 43 of file particle_flux.h.

template<typename VectorCoeffType>

bool Antioch::ParticleFlux< VectorCoeffType >::_x_updated

private

Definition at line 44 of file particle_flux.h.

---

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

• src/particles_flux/include/antioch/particle_flux.h