A particle class for use with Ito diffusion, i.e. drift-diffusion brownian walkers. More...
#include <CD_ItoPlasmaGodunovParticle.H>
Inheritance diagram for Physics::ItoPlasma::ItoPlasmaGodunovParticle:
Collaboration diagram for Physics::ItoPlasma::ItoPlasmaGodunovParticle:
Public Member Functions | |
| ItoPlasmaGodunovParticle () | |
| Default constructor. More... | |
| ItoPlasmaGodunovParticle (const RealVect a_position, const Real a_mass) | |
| Constructor. Subsequently calls define. More... | |
| virtual | ~ItoPlasmaGodunovParticle () |
| Default dtor. More... | |
| void | define (const RealVect a_position, const Real a_mass) |
| For non-default ctor. More... | |
| void | setMass (const Real a_mass) |
| Set particle mass. More... | |
| Real & | mass () |
| Get mass. More... | |
| const Real & | mass () const |
| Const retrieve mass. More... | |
| virtual int | size () const |
| Returns the size, in number of bytes, of a flat representation of the data in this object. More... | |
| virtual void | linearOut (void *buf) const |
| Write a linear binary representation of the internal data. Assumes that sufficient memory for the buffer has already been allocated by the caller. More... | |
| virtual void | linearIn (void *buf) |
| Read a linear binary representation of the internal data. Assumes that the buffer has the correct data. More... | |
Protected Attributes | |
| Real | m_mass |
Detailed Description
A particle class for use with Ito diffusion, i.e. drift-diffusion brownian walkers.
Constructor & Destructor Documentation
◆ ItoPlasmaGodunovParticle() [1/2]
| ItoPlasmaGodunovParticle::ItoPlasmaGodunovParticle | ( | ) |
Default constructor.
◆ ItoPlasmaGodunovParticle() [2/2]
| ItoPlasmaGodunovParticle::ItoPlasmaGodunovParticle | ( | const RealVect | a_position, |
| const Real | a_mass | ||
| ) |
Constructor. Subsequently calls define.
◆ ~ItoPlasmaGodunovParticle()
|
virtual |
Default dtor.
Member Function Documentation
◆ define()
| void ItoPlasmaGodunovParticle::define | ( | const RealVect | a_position, |
| const Real | a_mass | ||
| ) |
For non-default ctor.
◆ linearIn()
|
virtual |
Read a linear binary representation of the internal data. Assumes that the buffer has the correct data.
◆ linearOut()
|
virtual |
Write a linear binary representation of the internal data. Assumes that sufficient memory for the buffer has already been allocated by the caller.
◆ mass() [1/2]
| const Real & ItoPlasmaGodunovParticle::mass | ( | ) |
Get mass.
◆ mass() [2/2]
| const Real& Physics::ItoPlasma::ItoPlasmaGodunovParticle::mass | ( | ) | const |
Const retrieve mass.
◆ setMass()
| void ItoPlasmaGodunovParticle::setMass | ( | const Real | a_mass | ) |
Set particle mass.
◆ size()
|
virtual |
Returns the size, in number of bytes, of a flat representation of the data in this object.
The documentation for this class was generated from the following files:
- Physics/ItoPlasma/TimeSteppers/ItoPlasmaGodunovStepper/CD_ItoPlasmaGodunovParticle.H
- Physics/ItoPlasma/TimeSteppers/ItoPlasmaGodunovStepper/CD_ItoPlasmaGodunovParticle.cpp
