PoissonSolver Class Reference

#include <PoissonSolver.h>

Inheritance diagram for PoissonSolver:

Public Member Functions
virtual void	computePotential (Field_t &rho, Vector_t hr)=0
virtual void	solve (AmrScalarFieldContainer_t &, AmrScalarFieldContainer_t &, AmrVectorFieldContainer_t &, unsigned short, unsigned short, bool=true)
virtual void	hasToRegrid ()
virtual void	computePotential (Field_t &rho, Vector_t hr, double zshift)=0
virtual double	getXRangeMin (unsigned short level=0)=0
virtual double	getXRangeMax (unsigned short level=0)=0
virtual double	getYRangeMin (unsigned short level=0)=0
virtual double	getYRangeMax (unsigned short level=0)=0
virtual double	getZRangeMin (unsigned short level=0)=0
virtual double	getZRangeMax (unsigned short level=0)=0
virtual void	test (PartBunchBase< double, 3 > *bunch)=0
virtual	~PoissonSolver ()
virtual void	resizeMesh (Vector_t &, Vector_t &, const Vector_t &, const Vector_t &, double)

Protected Types
typedef Field< int, 3, Mesh_t, Center_t >	IField_t
typedef Field< std::complex< double >, 3, Mesh_t, Center_t >	CxField_t

Detailed Description

Definition at line 16 of file PoissonSolver.h.

Member Typedef Documentation

CxField_t

typedef Field<std::complex<double>, 3, Mesh_t, Center_t> PoissonSolver::CxField_t

protected

Definition at line 20 of file PoissonSolver.h.

IField_t

typedef Field<int, 3, Mesh_t, Center_t> PoissonSolver::IField_t

protected

Definition at line 19 of file PoissonSolver.h.

Constructor & Destructor Documentation

~PoissonSolver()

virtual PoissonSolver::~PoissonSolver ( )

inlinevirtual

Definition at line 66 of file PoissonSolver.h.

Member Function Documentation

computePotential() [1/2]

virtual void PoissonSolver::computePotential ( Field_t &  rho, Vector_t  hr  )

pure virtual

Implemented in P3MPoissonSolver, MGPoissonSolver, FFTPoissonSolver, FFTBoxPoissonSolver, AmrPoissonSolver< AmrObject >, and AmrPoissonSolver< AmrBoxLib >.

Referenced by PartBunch::computeSelfFields(), and PartBunch::computeSelfFields_cycl().

computePotential() [2/2]

virtual void PoissonSolver::computePotential ( Field_t &  rho, Vector_t  hr, double  zshift  )

pure virtual

Implemented in P3MPoissonSolver, MGPoissonSolver, FFTPoissonSolver, FFTBoxPoissonSolver, AmrPoissonSolver< AmrObject >, and AmrPoissonSolver< AmrBoxLib >.

getXRangeMax()

virtual double PoissonSolver::getXRangeMax ( unsigned short  level = 0 )

pure virtual

Implemented in P3MPoissonSolver, MGPoissonSolver, FFTPoissonSolver, FFTBoxPoissonSolver, FMGPoissonSolver, MLPoissonSolver, and AmrMultiGrid.

Referenced by PartBunch::resizeMesh().

getXRangeMin()

virtual double PoissonSolver::getXRangeMin ( unsigned short  level = 0 )

pure virtual

Implemented in P3MPoissonSolver, MGPoissonSolver, FFTPoissonSolver, FFTBoxPoissonSolver, FMGPoissonSolver, MLPoissonSolver, and AmrMultiGrid.

Referenced by PartBunch::resizeMesh().

getYRangeMax()

virtual double PoissonSolver::getYRangeMax ( unsigned short  level = 0 )

pure virtual

Implemented in P3MPoissonSolver, MGPoissonSolver, FFTPoissonSolver, FFTBoxPoissonSolver, FMGPoissonSolver, MLPoissonSolver, and AmrMultiGrid.

Referenced by PartBunch::resizeMesh().

getYRangeMin()

virtual double PoissonSolver::getYRangeMin ( unsigned short  level = 0 )

pure virtual

Implemented in P3MPoissonSolver, MGPoissonSolver, FFTPoissonSolver, FFTBoxPoissonSolver, FMGPoissonSolver, MLPoissonSolver, and AmrMultiGrid.

Referenced by PartBunch::resizeMesh().

getZRangeMax()

virtual double PoissonSolver::getZRangeMax ( unsigned short  level = 0 )

pure virtual

Implemented in P3MPoissonSolver, MGPoissonSolver, FFTPoissonSolver, FFTBoxPoissonSolver, FMGPoissonSolver, MLPoissonSolver, and AmrMultiGrid.

getZRangeMin()

virtual double PoissonSolver::getZRangeMin ( unsigned short  level = 0 )

pure virtual

Implemented in P3MPoissonSolver, MGPoissonSolver, FFTPoissonSolver, FFTBoxPoissonSolver, FMGPoissonSolver, MLPoissonSolver, and AmrMultiGrid.

hasToRegrid()

virtual void PoissonSolver::hasToRegrid ( )

inlinevirtual

Tell solver to regrid

Reimplemented in AmrPoissonSolver< AmrObject >, and AmrPoissonSolver< AmrBoxLib >.

Definition at line 52 of file PoissonSolver.h.

Referenced by AmrBoxLib::postRegrid_m().

resizeMesh()

virtual void PoissonSolver::resizeMesh ( Vector_t &  , Vector_t &  , const Vector_t &  , const Vector_t &  , double    )

inlinevirtual

Reimplemented in MGPoissonSolver.

Definition at line 68 of file PoissonSolver.h.

Referenced by PartBunch::resizeMesh().

solve()

virtual void PoissonSolver::solve ( AmrScalarFieldContainer_t &  , AmrScalarFieldContainer_t &  , AmrVectorFieldContainer_t &  , unsigned short  , unsigned short  , bool  = true  )

inlinevirtual

AMR solver calls

Parameters

rho	right-hand side charge density on grid [C / m]
phi	electrostatic potential (unknown) [V]
efield	electric field [V / m]
baseLevel	for solve
finestLevel	for solve
prevAsGuess	use of previous solution as initial guess

Reimplemented in FMGPoissonSolver, MLPoissonSolver, and AmrMultiGrid.

Definition at line 39 of file PoissonSolver.h.

Referenced by AmrBoxLib::computeSelfFields_cycl(), and AmrBoxLib::solvePoisson_m().

test()

virtual void PoissonSolver::test ( PartBunchBase< double, 3 > *  bunch )

pure virtual

Implemented in P3MPoissonSolver, MGPoissonSolver, FFTPoissonSolver, FFTBoxPoissonSolver, AmrPoissonSolver< AmrObject >, and AmrPoissonSolver< AmrBoxLib >.

Referenced by PartBunch::runTests().

---

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

• /Users/gsell/src/OPAL/src/src/Solvers/PoissonSolver.h