Chombo + EB  3.2
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
PetscSolver< T > Class Template Referenceabstract

#include <PetscSolver.H>

Inheritance diagram for PetscSolver< T >:
Inheritance graph
[legend]

Public Member Functions

 PetscSolver ()
 
virtual ~PetscSolver ()
 
void destroy ()
 
virtual void setHomogeneous (bool a_homogeneous)
 
virtual void define (Real a_dx, bool a_homogeneous=true)
 
virtual void define (LinearOp< T > *, bool a_homogeneous=true)
 
virtual void solve (T &a_phi, const T &a_rhs)
 
int solve_private (T &a_phi, const T &a_rhs)
 
virtual void solve_mfree (T &a_phi, const T &a_rhs, LinearOp< T > *a_op)
 
int solve_mfree_private (T &a_phi, const T &a_rhs, LinearOp< T > *a_op)
 
Real computeResidual ()
 
virtual int applyOp (T &a_phi, const T &a_rhs)
 
void setInitialGuessNonzero (bool b=true)
 
void setOptionsPrefix (const char prefix[])
 
virtual int getNNZPerRow () const
 
virtual bool supportNNZExact () const
 
virtual void rhsOperation (const T &a_rhs)
 
virtual Real addBCdiagValue (const IntVect &a_iv, const IntVect &a_jv, const T &a_rhs, DataIterator dit, const Real coeff=1)
 
int resetOperator ()
 
Real normInfinity (const T &a_phi) const
 
int setup_solver (const T &a_phi)
 
int create_mat_vec (const T &a_phi)
 
virtual BaseFab< Real > & getRegFab (T &a_fab, DataIterator &dit)=0
 
virtual const BaseFab< Real > & getRegFab (const T &a_fab, DataIterator &dit) const =0
 
virtual const BaseFab< Real > & getRegFab (const T &a_fab, DataIterator &dit, Box &a_box) const =0
 
void setNull (bool n=true)
 
- Public Member Functions inherited from LinearSolver< T >
virtual ~LinearSolver ()
 
virtual void setConvergenceMetrics (Real a_metric, Real a_tolerance)
 Set a convergence metric, along with solver tolerance, if desired. More...
 

Public Attributes

LinearOp< T > * m_op_mfree
 
m_phi_mfree
 
m_Lphi_mfree
 
bool m_mfree_homogeneous
 
bool m_homogeneous
 
Real m_dx
 

Protected Member Functions

virtual Real addBCrhsValue (const IntVect &a_iv, const T &a_phi, DataIterator dit, const Real &coeff=1)
 

Protected Attributes

char m_prestring [32]
 
bool m_null
 
bool m_nz_init_guess
 
LevelData< BaseFab< bool > > m_bccode
 

Detailed Description

template<class T>
class PetscSolver< T >

Interface to PETSC linear solvers BC implementation hooks: addBCdiagValue (formMatrix) and addBCrhsValue (solveprivate) m_bccode should be encoded true for cells that are at the domain boundaries at formMatrix time.

Constructor & Destructor Documentation

template<class T >
PetscSolver< T >::PetscSolver ( )
template<class T >
PetscSolver< T >::~PetscSolver ( )
virtual

Member Function Documentation

template<class T >
void PetscSolver< T >::destroy ( )
template<class T>
virtual void PetscSolver< T >::setHomogeneous ( bool  a_homogeneous)
inlinevirtual

Set whether the solver uses only homogeneous boundary conditions

Implements LinearSolver< T >.

template<class T >
void PetscSolver< T >::define ( Real  a_dx,
bool  a_homogeneous = true 
)
virtual

Set Function F(u) = 0 and Jacobian dF(u)/du for nonlinear solves

Reimplemented in PetscSolverPoisson< T >.

References CH_assert.

Referenced by PetscSolverPoisson< T >::define().

template<class T>
void PetscSolver< T >::define ( LinearOp< T > *  a_operator,
bool  a_homogeneous = true 
)
virtual

Define the operator and whether it is a homogeneous solver or not. The LinearSolver does not take over ownership of this a_operator object. It does not call delete on it when the LinearSolver is deleted. It is meant to be like a late-binding reference. If you created a_operator with new, you should call delete on it after LinearSolver is deleted if you want to avoid memory leaks.

Implements LinearSolver< T >.

Reimplemented in PetscSolverPoisson< T >.

References LinearOp< T >::dx().

template<class T>
void PetscSolver< T >::solve ( T &  a_phi,
const T &  a_rhs 
)
virtual

Solve

Implements LinearSolver< T >.

template<class T>
int PetscSolver< T >::solve_private ( T &  a_phi,
const T &  a_rhs 
)
template<class T>
void PetscSolver< T >::solve_mfree ( T &  a_phi,
const T &  a_rhs,
LinearOp< T > *  a_op 
)
virtual

Solve a_op*a_phi = a_rhs using the PETSC matrix free functions The preconditioner (for which a matrix is formed) need not be the same as the actual operator.

template<class T>
int PetscSolver< T >::solve_mfree_private ( T &  a_phi,
const T &  a_rhs,
LinearOp< T > *  a_op 
)
template<class T >
Real PetscSolver< T >::computeResidual ( )
template<class T>
int PetscSolver< T >::applyOp ( T &  a_phi,
const T &  a_rhs 
)
virtual

apply

template<class T>
void PetscSolver< T >::setInitialGuessNonzero ( bool  b = true)
inline

set initial guess non-zero

template<class T>
void PetscSolver< T >::setOptionsPrefix ( const char  prefix[])
inline

set initial guess non-zero

template<class T>
virtual int PetscSolver< T >::getNNZPerRow ( ) const
inlinevirtual

get an estimate of the number of nnz/row for matrix allocation

Reimplemented in PetscSolverViscousTensor< T >.

template<class T>
virtual bool PetscSolver< T >::supportNNZExact ( ) const
inlinevirtual

do I support having formMatrix precompute exact NNZ/row

template<class T>
virtual void PetscSolver< T >::rhsOperation ( const T &  a_rhs)
inlinevirtual
template<class T>
virtual Real PetscSolver< T >::addBCdiagValue ( const IntVect a_iv,
const IntVect a_jv,
const T &  a_rhs,
DataIterator  dit,
const Real  coeff = 1 
)
inlinevirtual

handling boundary conditions, turn it into a term to be added to the diag term this function coordinates with addBCrhsValue for Dirichlet BC for Neumann BC no RHS modification is required

template<class T>
int PetscSolver< T >::resetOperator ( )
inline
template<class T>
Real PetscSolver< T >::normInfinity ( const T &  a_phi) const

Infinity norm

References norm().

template<class T>
virtual Real PetscSolver< T >::addBCrhsValue ( const IntVect a_iv,
const T &  a_phi,
DataIterator  dit,
const Real coeff = 1 
)
inlineprotectedvirtual

handling boundary conditions, turn it into a term to be added to the RHS this function coordinates with addBCdiagValue for Dirichlet BC, should return a term that is to be added to RHS

template<class T>
int PetscSolver< T >::setup_solver ( const T &  a_phi)
template<class T>
int PetscSolver< T >::create_mat_vec ( const T &  a_phi)
template<class T>
virtual BaseFab<Real>& PetscSolver< T >::getRegFab ( T &  a_fab,
DataIterator dit 
)
pure virtual
template<class T>
virtual const BaseFab<Real>& PetscSolver< T >::getRegFab ( const T &  a_fab,
DataIterator dit 
) const
pure virtual
template<class T>
virtual const BaseFab<Real>& PetscSolver< T >::getRegFab ( const T &  a_fab,
DataIterator dit,
Box a_box 
) const
pure virtual
template<class T >
void PetscSolver< T >::setNull ( bool  n = true)

References CH_assert.

Member Data Documentation

template<class T>
LinearOp<T>* PetscSolver< T >::m_op_mfree
template<class T>
T PetscSolver< T >::m_phi_mfree
template<class T>
T PetscSolver< T >::m_Lphi_mfree
template<class T>
bool PetscSolver< T >::m_mfree_homogeneous
template<class T>
bool PetscSolver< T >::m_homogeneous

public member data: whether or not to use inhomogeneous boundary conditions.

Referenced by PetscSolver< LevelData< FArrayBox > >::setHomogeneous().

template<class T>
Real PetscSolver< T >::m_dx

member data: grid spacing

Referenced by PetscSolver< T >::PetscSolver().

template<class T>
char PetscSolver< T >::m_prestring[32]
protected
template<class T>
bool PetscSolver< T >::m_null
protected
template<class T>
bool PetscSolver< T >::m_nz_init_guess
protected
template<class T>
LevelData<BaseFab<bool> > PetscSolver< T >::m_bccode
protected

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