O P A R - Open Architecture Particle in Cell Simulation - Version 3.0
Plasma simulations with dust particles
 All Classes Files Functions Variables Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes
ElStaticNorm Class Reference

Normalization used for electrostatic simulations. More...

#include <normalization.h>

Inheritance diagram for ElStaticNorm:
Normalization Task

List of all members.

Public Member Functions

 ElStaticNorm ()
 Default constructor.
virtual ~ElStaticNorm ()
 Destructor.
virtual void Init ()
 The Init method of a Task is called before the Task is executed. It should contain all the necessary initialization. The basic Init method calls the Init of all the sub-Tasks and sorts them according to their predecessor list. Also the Pointer to the Normalization object is retrieved from the Process. A derived class should always call the Task::Init in its own Init method.
virtual bool Execute ()
 Executes the Task. This is the place where the algorithm for executing a Task it placed. The return value specifies, if the task is finished and can be removed. The basic Execute method executes all its sub-Tasks. The derived classes should call this member function, whenever there are subtasks to be executed.
virtual void length (double &)
virtual void time (double &)
virtual void frequency (double &)
virtual void mass (double &)
virtual void charge (double &)
virtual void potential (double &)
virtual void density (double &)
virtual void temperature (double &)
virtual double GetTe () const
virtual double GetTi () const
virtual double Getdebye () const
virtual double Getdebye_i () const
virtual double Getdebye_d () const
virtual double GetLaRadius () const
virtual double GetBfield () const
- Public Member Functions inherited from Normalization
virtual void SetSpecies (Species *)
 Some normalizations depend on the Species.
virtual std::string GetClassName () const
 Returns the name of the class, here "Normalization".
- Public Member Functions inherited from Task
 Task ()
 Default constructor sets the running number nNr of the Task.
virtual ~Task ()
 When destructing a Task is has to be detatched from the parents Task list.
int GetStep () const
 Return the interval between execution in timesteps.
int GetEnd () const
 Return the timestep when the Task ends execution.
bool DoNow ()
 Returns true if the Task is to be executed now.
std::string GetName () const
 Returns the name given to the Task object.
virtual bool IsInteractive () const
 If not specified otherwise, a Task is not interactive.
void AttachTask (Task *pTask)
 Insert Task into Task list and registers it with the Process.
void DetachTask (Task *pTask)
 DetachTask from Task list.
virtual std::string Rebuild (std::istream &in)
 Rebuilds the task from the setup. This normally does not need to be overwritten. Rebuild always returns the next token that does not belong to the object setup.
virtual void DumpTaskList (std::ostream &o, int nDepth=0)
 Recursively dumps the complete Task list into a stream.

Protected Member Functions

virtual PARAMETERMAP * MakeParamMap (PARAMETERMAP *pm=NULL)
 Register the parameters needed for the Task. A derived class should overwrite this whenever it needs additional parameters from the setup file. It should then ALWAYS call the MakeParamMap of its superclass.

Protected Attributes

double debye
 $\lambda_e$ : Debyelength electrons
double debye_i
 $\lambda_i$ : Debyelength ions
double debye_d
 $\lambda_d$ : Debyelength linearised
double n
 $n_0$ : The non normalized density
double Te
 $T_e$ : The temperature of electrons in eV
double Ti
 $T_i$ : The temperature of ions in eV
double omega
 $\omega_e$ : Plasma frequency of electrons
double Bz
 $B_z$ : Magnetic flux density
double omega_l
 $\omega_l$ : Gyration (Larmor) frequency
double rg
 $r_g$ : Gyration (Larmor) radius

Detailed Description

Normalization used for electrostatic simulations.

Quantities:

Normalizations:

Parameters:
nThe non normalized density
TeThe temperature in eV
TiThe temperature in eV
rgThe most probably gyration radius of electrons in mircometer

Member Function Documentation

double ElStaticNorm::GetBfield ( ) const
virtual

Un-Normalization methods for length, time, frequency, mass, charge, potential, density and temperature

Implements Normalization.


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