Overture  Version 25
Public Member Functions | Protected Attributes | List of all members
EquationSolver Class Referenceabstract

#include <EquationSolver.h>

Inheritance diagram for EquationSolver:
Inheritance graph
[legend]
Collaboration diagram for EquationSolver:
Collaboration graph
[legend]

Public Member Functions

 EquationSolver (Oges &oges_)
 
virtual ~EquationSolver ()
 
virtual int solve (realCompositeGridFunction &u, realCompositeGridFunction &f)=0
 
virtual int saveBinaryMatrix (aString filename00, realCompositeGridFunction &u, realCompositeGridFunction &f)
 
virtual int setCoefficientsAndBoundaryConditions (realCompositeGridFunction &coeff, const IntegerArray &boundaryConditions, const RealArray &bcData)
 
virtual int setCoefficientArray (realCompositeGridFunction &coeff, const IntegerArray &boundaryConditions=Overture::nullIntArray(), const RealArray &bcData=Overture::nullRealArray())
 
virtual int setEquationAndBoundaryConditions (OgesParameters::EquationEnum equation, CompositeGridOperators &op, const IntegerArray &boundaryConditions, const RealArray &bcData, RealArray &constantCoeff=Overture::nullRealArray(), realCompositeGridFunction *variableCoeff=NULL)
 
virtual int setGrid (CompositeGrid &cg)
 
virtual int set (MultigridCompositeGrid &mgcg)
 
const aStringgetName () const
 
virtual real getMaximumResidual ()
 
virtual int printStatistics (FILE *file=stdout) const
 
virtual int setExtraEquationValues (realCompositeGridFunction &f, real *value)
 
virtual int getExtraEquationValues (const realCompositeGridFunction &u, real *value)
 
virtual int evaluateExtraEquation (const realCompositeGridFunction &u, real &value, int extraEquation=0)
 
virtual int evaluateExtraEquation (const realCompositeGridFunction &u, real &value, real &sumOfExtraEquationCoefficients, int extraEquation=0)
 
virtual int allocateMatrix (int, int, int, int)
 
virtual int setMatrixElement (int, int, int, real)
 
virtual int displayMatrix ()
 
virtual real sizeOf (FILE *file=NULL)
 

Protected Attributes

Ogesoges
 
OgesParametersparameters
 
aString name
 
int numberOfEquations
 
int numberOfNonzeros
 
real maximumResidual
 
int numberOfIterations
 
int solverMethod
 
int preconditioner
 
int matrixOrdering
 
int numberOfIncompleteLULevels
 
int gmresRestartLength
 

Constructor & Destructor Documentation

EquationSolver::EquationSolver ( Oges oges_)
EquationSolver::~EquationSolver ( )
virtual

Member Function Documentation

int EquationSolver::allocateMatrix ( int  ndia,
int  ndja,
int  nda,
int  N 
)
virtual

Reimplemented in PETScEquationSolver.

Referenced by Oges::formMatrix().

int EquationSolver::displayMatrix ( )
virtual

Reimplemented in PETScEquationSolver.

Referenced by Oges::generateMatrix().

int EquationSolver::evaluateExtraEquation ( const realCompositeGridFunction u,
real value,
int  extraEquation = 0 
)
virtual

Reimplemented in PETScSolver.

Referenced by Oges::evaluateExtraEquation().

int EquationSolver::evaluateExtraEquation ( const realCompositeGridFunction u,
real value,
real sumOfExtraEquationCoefficients,
int  extraEquation = 0 
)
virtual
int EquationSolver::getExtraEquationValues ( const realCompositeGridFunction u,
real value 
)
virtual
real EquationSolver::getMaximumResidual ( )
virtual

Reimplemented in PETScEquationSolver, and PETScSolver.

References maximumResidual.

Referenced by Oges::getMaximumResidual().

const aString & EquationSolver::getName ( ) const

References name.

int EquationSolver::printStatistics ( FILE *  file = stdout) const
virtual
int EquationSolver::saveBinaryMatrix ( aString  filename00,
realCompositeGridFunction u,
realCompositeGridFunction f 
)
virtual

Reimplemented in PETScEquationSolver.

Referenced by Oges::writePetscMatrixToFile().

int EquationSolver::set ( MultigridCompositeGrid mgcg)
virtual

Reimplemented in MultigridEquationSolver.

References printF().

Referenced by Oges::buildEquationSolvers().

int EquationSolver::setCoefficientArray ( realCompositeGridFunction coeff,
const IntegerArray boundaryConditions = Overture::nullIntArray(),
const RealArray bcData = Overture::nullRealArray() 
)
virtual

Reimplemented in MultigridEquationSolver.

References printF().

Referenced by Oges::setCoefficientArray().

int EquationSolver::setCoefficientsAndBoundaryConditions ( realCompositeGridFunction coeff,
const IntegerArray boundaryConditions,
const RealArray bcData 
)
virtual
int EquationSolver::setEquationAndBoundaryConditions ( OgesParameters::EquationEnum  equation,
CompositeGridOperators op,
const IntegerArray boundaryConditions,
const RealArray bcData,
RealArray constantCoeff = Overture::nullRealArray(),
realCompositeGridFunction variableCoeff = NULL 
)
virtual
int EquationSolver::setExtraEquationValues ( realCompositeGridFunction f,
real value 
)
virtual
int EquationSolver::setGrid ( CompositeGrid cg)
virtual

Reimplemented in MultigridEquationSolver.

References printF().

Referenced by Oges::setGrid().

int EquationSolver::setMatrixElement ( int  nzcounter,
int  i,
int  j,
real  value 
)
virtual

Reimplemented in PETScEquationSolver.

Referenced by Oges::generateMatrix().

real EquationSolver::sizeOf ( FILE *  file = NULL)
virtual
virtual int EquationSolver::solve ( realCompositeGridFunction u,
realCompositeGridFunction f 
)
pure virtual

Member Data Documentation

int EquationSolver::gmresRestartLength
protected
int EquationSolver::matrixOrdering
protected
real EquationSolver::maximumResidual
protected
aString EquationSolver::name
protected
int EquationSolver::numberOfEquations
protected
int EquationSolver::numberOfIncompleteLULevels
protected
int EquationSolver::numberOfIterations
protected
int EquationSolver::numberOfNonzeros
protected
Oges& EquationSolver::oges
protected
OgesParameters& EquationSolver::parameters
protected
int EquationSolver::preconditioner
protected
int EquationSolver::solverMethod
protected

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