LinearOp< T > Class Template Reference

#include <LinearSolver.H>

Inheritance diagram for LinearOp< T >:

Detailed Description

template<class T>
class LinearOp< T >

Operator class for Linear solver for solving L(phi) = rhs.


Public Member Functions
virtual	~LinearOp ()
virtual void	residual (T &a_lhs, const T &a_phi, const T &a_rhs, bool a_homogeneous=false)=0
virtual void	preCond (T &a_cor, const T &a_residual)=0
virtual void	applyOp (T &a_lhs, const T &a_phi, bool a_homogeneous=false)=0
virtual void	create (T &a_lhs, const T &a_rhs)=0
virtual void	clear (T &a_lhs)
virtual void	assign (T &a_lhs, const T &a_rhs)=0
virtual void	assignLocal (T &a_lhs, const T &a_rhs)
virtual Real	dotProduct (const T &a_1, const T &a_2)=0
virtual void	incr (T &a_lhs, const T &a_x, Real a_scale)=0
virtual void	axby (T &a_lhs, const T &a_x, const T &a_y, Real a_a, Real a_b)=0
virtual void	scale (T &a_lhs, const Real &a_scale)=0
virtual Real	norm (const T &a_rhs, int a_ord)=0
virtual void	setToZero (T &a_lhs)=0
virtual void	write (const T a, const char filename)

Constructor & Destructor Documentation

template<class T>

virtual LinearOp< T >::~LinearOp ( ) [inline, virtual]

Member Function Documentation

template<class T>

virtual void LinearOp< T >::residual	(	T &	a_lhs,
		const T &	a_phi,
		const T &	a_rhs,
		bool	a_homogeneous = `false`
	)			`[pure virtual]`

Say you are solving L(phi) = rhs. Make a_lhs = L(a_phi) - a_rhs. If a_homogeneous is true, evaluate the operator using homogeneous boundary conditions.

Implemented in AMRNodeOp, AMRPoissonOp, MultilevelLinearOp< T >, NewPoissonOp, ResistivityOp, VCAMRPoissonOp, ViscousTensorOp, EBAMRPoissonOp, EBConductivityOp, EBPoissonOp, and EBViscousTensorOp.

template<class T>

virtual void LinearOp< T >::preCond	(	T &	a_cor,
		const T &	a_residual
	)			`[pure virtual]`

Given the current state of the residual the correction, apply your preconditioner to a_cor.

Implemented in AMRNodeOp, AMRPoissonOp, MultilevelLinearOp< T >, NewPoissonOp, ResistivityOp, VCAMRPoissonOp, VCAMRPoissonOp2, ViscousTensorOp, EBAMRPoissonOp, EBConductivityOp, EBPoissonOp, and EBViscousTensorOp.

template<class T>

virtual void LinearOp< T >::applyOp	(	T &	a_lhs,
		const T &	a_phi,
		bool	a_homogeneous = `false`
	)			`[pure virtual]`

In the context of solving L(phi) = rhs, set a_lhs = L(a_phi). If a_homogeneous is true, evaluate the operator using homogeneous boundary conditions.

Implemented in AMRNodeOp, AMRPoissonOp, MultilevelLinearOp< T >, NewPoissonOp, ResistivityOp, VCAMRPoissonOp, ViscousTensorOp, EBAMRPoissonOp, EBConductivityOp, EBPoissonOp, and EBViscousTensorOp.

template<class T>

virtual void LinearOp< T >::create	(	T &	a_lhs,
		const T &	a_rhs
	)			`[pure virtual]`

Creat data holder a_lhs that mirrors a_rhs. You do not need to copy the data of a_rhs, just make a holder the same size.

Implemented in AMRNodeOp, AMRPoissonOp, MultilevelLinearOp< T >, NewPoissonOp, ResistivityOp, VCAMRPoissonOp, ViscousTensorOp, EBAMRPoissonOp, EBConductivityOp, EBPoissonOp, and EBViscousTensorOp.

Referenced by AMRMultiGrid< T >::init().

template<class T>

virtual void LinearOp< T >::clear ( T & a_lhs ) [inline, virtual]

Opposite of create -- perform any operations required before lhs goes out of scope. In general, the only time this needs to be defined in a derived class is if the create() function called new. Otherwise, the default no-op function is sufficient.

Reimplemented in MultilevelLinearOp< T >.

template<class T>

virtual void LinearOp< T >::assign	(	T &	a_lhs,
		const T &	a_rhs
	)			`[pure virtual]`

Set a_lhs equal to a_rhs.

Implemented in AMRNodeOp, AMRPoissonOp, MultilevelLinearOp< T >, NewPoissonOp, ResistivityOp, VCAMRPoissonOp, ViscousTensorOp, EBAMRPoissonOp, EBConductivityOp, EBPoissonOp, and EBViscousTensorOp.

Referenced by AMRLevelOp< LevelData< NodeFArrayBox > >::assignCopier(), and LinearOp< LevelData< NodeFArrayBox > >::assignLocal().

template<class T>

virtual void LinearOp< T >::assignLocal	(	T &	a_lhs,
		const T &	a_rhs
	)			`[inline, virtual]`

Reimplemented in AMRPoissonOp.

template<class T>

virtual Real LinearOp< T >::dotProduct	(	const T &	a_1,
		const T &	a_2
	)			`[pure virtual]`

Compute and return the dot product of a_1 and a_2. In most contexts, this means return the sum over all data points of a_1*a_2.

Implemented in AMRNodeOp, AMRPoissonOp, MultilevelLinearOp< T >, NewPoissonOp, ResistivityOp, VCAMRPoissonOp, ViscousTensorOp, EBAMRPoissonOp, EBConductivityOp, EBPoissonOp, and EBViscousTensorOp.

template<class T>

virtual void LinearOp< T >::incr	(	T &	a_lhs,
		const T &	a_x,
		Real	a_scale
	)			`[pure virtual]`

Increment by scaled amount (a_lhs += a_scale*a_x).

Implemented in AMRNodeOp, AMRPoissonOp, MultilevelLinearOp< T >, NewPoissonOp, ResistivityOp, VCAMRPoissonOp, ViscousTensorOp, EBAMRPoissonOp, EBConductivityOp, EBPoissonOp, and EBViscousTensorOp.

template<class T>

virtual void LinearOp< T >::axby	(	T &	a_lhs,
		const T &	a_x,
		const T &	a_y,
		Real	a_a,
		Real	a_b
	)			`[pure virtual]`

Set input to a scaled sum (a_lhs = a_a*a_x + a_b*a_y).

Implemented in AMRNodeOp, AMRPoissonOp, MultilevelLinearOp< T >, NewPoissonOp, ResistivityOp, VCAMRPoissonOp, ViscousTensorOp, EBAMRPoissonOp, EBConductivityOp, EBPoissonOp, and EBViscousTensorOp.

template<class T>

virtual void LinearOp< T >::scale	(	T &	a_lhs,
		const Real &	a_scale
	)			`[pure virtual]`

Multiply the input by a given scale (a_lhs *= a_scale).

Implemented in AMRNodeOp, AMRPoissonOp, MultilevelLinearOp< T >, NewPoissonOp, ResistivityOp, VCAMRPoissonOp, ViscousTensorOp, EBAMRPoissonOp, EBConductivityOp, EBPoissonOp, and EBViscousTensorOp.

template<class T>

virtual Real LinearOp< T >::norm	(	const T &	a_rhs,
		int	a_ord
	)			`[pure virtual]`

Return the norm of a_rhs. a_ord == 0 max norm, a_ord == 1 sum(abs(a_rhs)), else, L(a_ord) norm.

Implemented in AMRNodeOp, AMRPoissonOp, MultilevelLinearOp< T >, NewPoissonOp, ResistivityOp, VCAMRPoissonOp, ViscousTensorOp, EBAMRPoissonOp, EBConductivityOp, EBPoissonOp, and EBViscousTensorOp.

Referenced by AMRLevelOp< LevelData< NodeFArrayBox > >::AMRNorm(), and AMRLevelOp< LevelData< NodeFArrayBox > >::localMaxNorm().

template<class T>

virtual void LinearOp< T >::setToZero ( T & a_lhs ) [pure virtual]

Set a_lhs to zero.

Implemented in AMRNodeOp, AMRPoissonOp, MultilevelLinearOp< T >, NewPoissonOp, ResistivityOp, VCAMRPoissonOp, ViscousTensorOp, EBAMRPoissonOp, EBConductivityOp, EBPoissonOp, and EBViscousTensorOp.

Referenced by AMRLevelOp< LevelData< NodeFArrayBox > >::zeroCovered().

template<class T>

virtual void LinearOp< T >::write	(	const T *	a,
		const char *	filename
	)			`[inline, virtual]`

Debugging aid for solvers. Print out a "T" to a file named "filename" default implementation is to print out a message saying "LinearOp::write not implemented"

Reimplemented in AMRPoissonOp, MultilevelLinearOp< T >, and VCAMRPoissonOp.

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

LinearSolver.H

LinearOp< T > Class Template Reference

Detailed Description

template<class T> class LinearOp< T >

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

template<class T>
class LinearOp< T >