#include <Oges.h>

Collaboration diagram for Oges:

Public Types
enum	SparseStorageFormatEnum { uncompressed, compressedRow, other }

enum	EquationSolverEnum { maximumNumberOfEquationSolvers =10 }

enum	coefficientTypes { continuous =0, discrete =1 }

enum	solvers { yale =1, harwell =2, bcg =3, sor =4, SLAP, PETSc }

enum	conjugateGradientTypes { biConjugateGradient =0, biConjugateGradientSquared =1, GMRes =2, CGStab =3 }

enum	conjugateGradientPreconditioners { none =0, diagonal =1, incompleteLU =2, SSOR =3 }

Public Member Functions
	Oges ()

	Oges (CompositeGrid &cg)

	Oges (MappedGrid &mg)

	Oges (const Oges &X)

Oges &	operator= (const Oges &x)

virtual	~Oges ()

int	setEquationAndBoundaryConditions (OgesParameters::EquationEnum equation, CompositeGridOperators &op, const IntegerArray &boundaryConditions, const RealArray &bcData, RealArray &constantCoeff=Overture::nullRealArray(), realCompositeGridFunction *variableCoeff=NULL)
	!Define a predefined equation this is new **

int	setCoefficientsAndBoundaryConditions (realCompositeGridFunction &coeff, const IntegerArray &boundaryConditions, const RealArray &bcData)
	Supply matrix coefficients and boundary conditions (new way).

void	determineErrors (realCompositeGridFunction &u, OGFunction &exactSolution, int &printOptions)

aString	getErrorMessage (const int errorNumber)

int	get (OgesParameters::OptionEnum option, int &value) const

int	get (OgesParameters::OptionEnum option, real &value) const

int	getCompatibilityConstraint () const

int	getNumberOfIterations ()

real	getMaximumResidual () const

int	initialize ()

bool	isSolverIterative () const

bool	canSolveInPlace () const

int	getMatrix (IntegerArray &ia, IntegerArray &ja, RealArray &a, SparseStorageFormatEnum format=compressedRow)

int	matrixVectorMultiply (int n, real x, real y)

int	computeResidual (int n, real x, real b, real *r)

int	assignVector (int n, real *x, realCompositeGridFunction &u)

int	storeVector (int n, real *x, realCompositeGridFunction &u)

int	printStatistics (FILE *file=stdout) const

int	set (OgesParameters::SolverEnum option)

int	set (OgesParameters::SolverMethodEnum option)

int	set (OgesParameters::MatrixOrderingEnum option)

int	set (OgesParameters::PreconditionerEnum option)

int	set (OgesParameters::OptionEnum option, int value=0)

int	set (OgesParameters::OptionEnum option, float value)

int	set (OgesParameters::OptionEnum option, double value)

int	setOgesParameters (const OgesParameters &opar)

int	setExtraEquationValues (realCompositeGridFunction &f, real *value)

int	getExtraEquationValues (const realCompositeGridFunction &u, real *value)

int	evaluateExtraEquation (const realCompositeGridFunction &u, real &value, int extraEquation=0)

int	evaluateExtraEquation (const realCompositeGridFunction &u, real &value, real &sumOfExtraEquationCoefficients, int extraEquation=0)

virtual real	sizeOf (FILE *file=NULL) const

virtual int	get (const GenericDataBase &dir, const aString &name)

virtual int	put (GenericDataBase &dir, const aString &name) const

int	outputSparseMatrix (const aString &fileName)

int	writeMatrixToFile (aString fileName)

int	writeMatrixGridInformationToFile (aString fileName)

int	writePetscMatrixToFile (aString filename, realCompositeGridFunction &u, realCompositeGridFunction &f)

void	reference (const Oges &)

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

int	setCoefficientArray (realMappedGridFunction &coeff, const IntegerArray &boundaryConditions=Overture::nullIntArray(), const RealArray &bcData=Overture::nullRealArray())

int	setGridsToUse (const IntegerArray &gridsToUse)

bool	activeGrid (int grid) const

const IntegerArray &	getUseThisGrid () const

int	setCommandLineArguments (int argc, char **argv)

void	setGrid (CompositeGrid &cg, bool outOfDate=true)

void	setGrid (MappedGrid &mg, bool outOfDate=true)

void	set (MultigridCompositeGrid &mgcg)
	Supply a MultigridCompositeGrid (for use with the multigrid solver Ogmg).

void	setGridName (const aString &name)

void	setSolverName (const aString &name)

int	solve (realCompositeGridFunction &u, realCompositeGridFunction &f)

int	solve (realMappedGridFunction &u, realMappedGridFunction &f)

int	updateToMatchGrid (CompositeGrid &cg)

int	updateToMatchGrid (MappedGrid &mg)

int	update (GenericGraphicsInterface &gi, CompositeGrid &cg)

int	buildEquationSolvers (OgesParameters::SolverEnum solver)

int	formMatrix (int &numberOfEquations, int &numberOfNonzeros, SparseStorageFormatEnum storageFormat, bool allocateSpace=TRUE, bool factorMatrixInPlace=FALSE)

int	formRhsAndSolutionVectors (realCompositeGridFunction &u, realCompositeGridFunction &f)

int	storeSolutionIntoGridFunction ()

void	equationToIndex (const int eqnNo0, int &n, int &i1, int &i2, int &i3, int &grid)

int	printObsoleteMessage (const aString &routineName, int option=0)

void	setCompositeGrid (CompositeGrid &cg)

void	setConjugateGradientType (const conjugateGradientTypes conjugateGradientType)

void	setConjugateGradientPreconditioner (const conjugateGradientPreconditioners conjugateGradientPreconditioner)

void	setConjugateGradientNumberOfIterations (const int conjugateGradientNumberOfIterations)

void	setConjugateGradientNumberOfSaveVectors (const int conjugateGradientNumberOfSaveVectors)

void	setConjugateGradientTolerance (const real conjugateGradientTolerance)

void	setCompatibilityConstraint (const bool trueOrFalse)

void	setEvaluateJacobian (const int EvaluateJacobian)

void	setFillinRatio (const real fillinRatio)

void	setFillinRatio2 (const real fillinRatio2)

void	setFixupRightHandSide (const bool trueOrFalse)

void	setHarwellTolerance (const real harwellTolerance)

void	setIterativeImprovement (const int trueOrFalse)

void	setNumberOfComponents (const int numberOfComponents)

void	setNullVectorScaling (const real &scale)

void	setMatrixCutoff (const real matrixCutoff)

void	setOrderOfAccuracy (const int order)

void	setPreconditionBoundary (const int preconditionBoundary)

void	setPreconditionRightHandSide (const int preconditionRightHandSide)

void	setRefactor (const int refactor)

void	setReorder (const int reorder)

void	setSolverJob (const int solverJob)

void	setSolverType (const solvers solverType)

void	setSorNumberOfIterations (const int sorNumberOfIterations)

void	setSorTolerance (const real sorTolerance)

void	setSorOmega (const real sorOmega)

void	setTranspose (const int transpose)

void	setZeroRatio (const real zeroRatio)

void	setCoefficientType (const coefficientTypes coefficientType)

Public Attributes
enum Oges::SparseStorageFormatEnum	sparseStorageFormat

int	ndia

int	ndja

int	nda

RealArray	sol

RealArray	rhs

IntegerArray	ia

IntegerArray	ja

RealArray	a

CompositeGrid	cg

OgesParameters	parameters

MultigridCompositeGrid	mgcg

realCompositeGridFunction	coeff

intArray *	classify

realCompositeGridFunction	uLinearized

ListOfRealSerialArray	ul

ListOfRealSerialArray	fl

int	numberOfExtraEquations

IntegerArray	extraEquationNumber

realCompositeGridFunction *	coefficientsOfDenseExtraEquations

realCompositeGridFunction	rightNullVector

int	solvingSparseSubset

int	solverJob

int	initialized

bool	shouldBeInitialized

int	numberOfGrids

int	numberOfDimensions

int	numberOfComponents

int	stencilSize

int	refactor

int	reorder

int	evaluateJacobian

bool	recomputePreconditioner

int	numberOfEquations

int	numberOfNonzerosBound

int	numberOfNonzeros

int	preconditionBoundary

int	preconditionRightHandSide

int	numberOfIterations

aString	gridName

aString	solverName

int	argc

char **	argv

EquationSolver *	equationSolver [maximumNumberOfEquationSolvers]

coefficientTypes	coefficientType

real	actualZeroRatio

real	actualFillinRatio

real	actualFillinRatio2

real	maximumResidual

Static Public Attributes
static int	debug =0

Protected Member Functions
void	setup ()

void	findExtraEquations ()

void	makeRightNullVector ()

void	generateMatrixError (const int nda, const int ieqn)

void	generateMatrix (int &errorNumber)

void	privateUpdateToMatchGrid ()

int	arraySize (const int grid, const int axis)

int	arrayDims (const int grid, const int side, const int axis)

int	equationNo (const int n, const int i1, const int i2, const int i3, const int grid)

IntegerDistributedArray	equationNo (const int n, const Index &I1, const Index &I2, const Index &I3, const int grid)

Protected Attributes
OgesParameters::EquationEnum	equationToSolve

RealArray	constantCoefficients

IntegerArray	boundaryConditions

RealArray	bcData

IntegerArray	gridEquationBase

bool	useAllGrids

IntegerArray	useThisGrid

Member Enumeration Documentation

enum Oges::coefficientTypes

Enumerator
continuous
discrete

enum Oges::conjugateGradientPreconditioners

Enumerator
none
diagonal
incompleteLU
SSOR

enum Oges::conjugateGradientTypes

Enumerator
biConjugateGradient
biConjugateGradientSquared
GMRes
CGStab

enum Oges::EquationSolverEnum

Enumerator
maximumNumberOfEquationSolvers

enum Oges::solvers

Enumerator
yale
harwell
bcg
sor
SLAP
PETSc

enum Oges::SparseStorageFormatEnum

Enumerator
uncompressed
compressedRow
other

Constructor & Destructor Documentation

Oges::Oges ( )

References setup().

Oges::Oges ( CompositeGrid & cg )

References cg, privateUpdateToMatchGrid(), CompositeGrid::reference(), and setup().

Oges::Oges ( MappedGrid & mg )

References cg, GenericGridCollectionData::numberOfComponentGrids, MappedGrid::numberOfDimensions(), privateUpdateToMatchGrid(), CompositeGrid::reference(), CompositeGrid::setNumberOfDimensionsAndGrids(), setup(), and CompositeGrid::updateReferences().

Oges::Oges ( const Oges & X )

References setup().

Oges::~Oges ( )

virtual

References argc, argv, classify, debug, equationSolver, maximumNumberOfEquationSolvers, and printF().

Member Function Documentation

bool Oges::activeGrid ( int grid ) const

int Oges::arrayDims	(	const int	grid,
		const int	side,
		const int	axis
	)

inlineprotected

References cg.

Referenced by equationToIndex(), and generateMatrix().

int Oges::arraySize	(	const int	grid,
		const int	axis
	)

inlineprotected

References cg, End, and Start.

Referenced by equationToIndex(), formMatrix(), generateMatrix(), and initialize().

int Oges::assignVector	(	int	n,
		real *	x,
		realCompositeGridFunction &	u
	)

int Oges::buildEquationSolvers ( OgesParameters::SolverEnum solver )

bool Oges::canSolveInPlace ( ) const

References isSolverIterative(), parameters, preconditionBoundary, and OgesParameters::solveForTranspose.

Referenced by formMatrix().

int Oges::computeResidual	(	int	n,
		real *	x,
		real *	b,
		real *	r
	)

References a, ia, ja, numberOfEquations, numberOfNonzeros, and OGES_RESIDUAL.

void Oges::determineErrors	(	realCompositeGridFunction &	u,
		OGFunction &	exactSolution,
		int &	printOptions
	)

int Oges::equationNo	(	const int	n,
		const int	i1,
		const int	i2,
		const int	i3,
		const int	grid
	)

inlineprotected

References axis1, axis2, axis3, cg, dimension, End, gridEquationBase, numberOfComponents, and Start.

Referenced by equationNo(), findExtraEquations(), and generateMatrix().

IntegerDistributedArray Oges::equationNo	(	const int	n,
		const Index &	I1,
		const Index &	I2,
		const Index &	I3,
		const int	grid
	)

protected

References equationNo(), and i2.

void Oges::equationToIndex	(	const int	eqnNo0,
		int &	n,
		int &	i1,
		int &	i2,
		int &	i3,
		int &	grid
	)

References arrayDims(), arraySize(), axis1, axis2, axis3, gridEquationBase, numberOfComponents, numberOfGrids, and Start.

Referenced by checkGrid(), Integrate::computeLeftNullVector(), determineErrors(), EquationSolver::getExtraEquationValues(), EquationSolver::setExtraEquationValues(), and writeMatrixGridInformationToFile().

int Oges::evaluateExtraEquation	(	const realCompositeGridFunction &	u,
		real &	value,
		int	extraEquation = `0`
	)

References assert, equationSolver, EquationSolver::evaluateExtraEquation(), NULL, parameters, and OgesParameters::solver.

int Oges::evaluateExtraEquation	(	const realCompositeGridFunction &	u,
		real &	value,
		real &	sumOfExtraEquationCoefficients,
		int	extraEquation = `0`
	)

References assert, equationSolver, EquationSolver::evaluateExtraEquation(), NULL, parameters, and OgesParameters::solver.

void Oges::findExtraEquations ( )

protected

References axis1, axis2, axis3, c, cg, coeff, MappedGrid::dimension(), End, equationNo(), extraEquationNumber, i2, numberOfExtraEquations, numberOfGrids, doubleGridCollectionFunction::sparse, Start, and SparseRepForMGF::unused.

Referenced by initialize().

int Oges::formMatrix	(	int &	numberOfEquations,
		int &	numberOfNonzeros,
		SparseStorageFormatEnum	storageFormat,
		bool	allocateSpace = `TRUE`,
		bool	factorMatrixInPlace = `FALSE`
	)

References a, actualZeroRatio, EquationSolver::allocateMatrix(), arraySize(), assert, axis1, axis2, axis3, canSolveInPlace(), classify, coeff, OgesParameters::compatibilityConstraint, compressedRow, debug, doubleGridCollectionFunction::destroy(), equationSolver, OgesParameters::fillinRatio, generateMatrix(), getCPU(), ia, initialize(), initialized, ja, OgesParameters::keepCoefficientGridFunction, OgesParameters::matrixCutoff, nda, ndia, ndja, numberOfComponents, numberOfEquations, numberOfExtraEquations, numberOfGrids, numberOfNonzeros, numberOfNonzerosBound, other, parameters, REAL_EPSILON, rhs, shouldBeInitialized, sol, OgesParameters::solveForTranspose, OgesParameters::solver, floatGridCollectionFunction::sparse, sparseStorageFormat, stencilSize, useAllGrids, useThisGrid, and OgesParameters::zeroRatio.

Referenced by getMatrix(), YaleEquationSolver::solve(), HarwellEquationSolver::solve(), and SlapEquationSolver::solve().

int Oges::formRhsAndSolutionVectors	(	realCompositeGridFunction &	u,
		realCompositeGridFunction &	f
	)

void Oges::generateMatrix ( int & errorNumber )

protected

!! kkc 060731 shouldn't RIGHTNULL have "n" as a subscript!?

References A, a, Overture::abort(), arrayDims(), arraySize(), assert, axis1, axis2, axis3, c, CC, cg, CLASSIFYX, coeff, COEFF, coefficientsOfDenseExtraEquations, OgesParameters::compatibilityConstraint, compressedRow, debug, displayCoeff(), EquationSolver::displayMatrix(), End, EQUATION_NO, equationNo(), EQUATIONNUMBER, equationSolver, extraEquationNumber, fabs(), generateMatrixError(), getCPU(), gridEqnBase, gridEquationBase, i2, ia, IA, JA, ja, OgesParameters::matrixCutoff, max(), min(), nda, ndja, NULL, Overture::nullRealMappedGridFunction(), numberOfComponents, numberOfEquations, numberOfExtraEquations, numberOfGrids, numberOfNonzeros, other, OV_ABORT, parameters, OgesParameters::PETSc, printF(), QS2I1, REAL_MIN, RIGHTNULL, rightNullVector, s, S, EquationSolver::setMatrixElement(), OgesParameters::SLAP, OgesParameters::solveForTranspose, OgesParameters::solver, doubleGridCollectionFunction::sparse, sparseStorageFormat, SQR, SS2Y, Start, stencilSize, TRUE, SparseRepForMGF::unused, useAllGrids, and useThisGrid.

Referenced by formMatrix().

void Oges::generateMatrixError	(	const int	nda,
		const int	ieqn
	)

protected

References numberOfEquations, parameters, and OgesParameters::zeroRatio.

Referenced by generateMatrix().

int Oges::get	(	OgesParameters::OptionEnum	option,
		int &	value
	)		const

Referenced by Ogmg::applyOgesSmoother(), and Ogmg::computeLeftNullVector().

int Oges::get	(	OgesParameters::OptionEnum	option,
		real &	value
	)		const

int Oges::get	(	const GenericDataBase &	dir,
		const aString &	name
	)

virtual

References GenericDataBase::find(), GenericDataBase::setMode(), GenericDataBase::streamInputMode, and GenericDataBase::virtualConstructor().

int Oges::getCompatibilityConstraint ( ) const

References OgesParameters::compatibilityConstraint, and parameters.

aString Oges::getErrorMessage ( const int errorNumber )

References CGESER.

int Oges::getExtraEquationValues	(	const realCompositeGridFunction &	u,
		real *	value
	)

References assert, equationSolver, EquationSolver::getExtraEquationValues(), NULL, parameters, and OgesParameters::solver.

int Oges::getMatrix	(	IntegerArray &	ia,
		IntegerArray &	ja,
		RealArray &	a,
		SparseStorageFormatEnum	format = `compressedRow`
	)

References a, assert, OgesParameters::compatibilityConstraint, debug, OgesParameters::fillinRatio, formMatrix(), getCPU(), ia, initialized, ja, numberOfDimensions, numberOfEquations, numberOfNonzeros, parameters, refactor, shouldBeInitialized, solverJob, and stencilSize.

real Oges::getMaximumResidual ( ) const

References equationSolver, EquationSolver::getMaximumResidual(), NULL, parameters, and OgesParameters::solver.

Referenced by Ogmg::applyOgesSmoother(), Ogmg::coarseGridSolverTest(), Ogmg::computeLeftNullVector(), and Integrate::computeWeights().

int Oges::getNumberOfIterations ( )

References numberOfIterations.

Referenced by Ogmg::applyOgesSmoother(), Ogmg::coarseGridSolverTest(), Ogmg::computeLeftNullVector(), and Ogmg::cycle().

const IntegerArray & Oges::getUseThisGrid ( ) const

References useThisGrid.

bool Oges::isSolverIterative ( ) const

References OgesParameters::multigrid, parameters, OgesParameters::PETSc, OgesParameters::PETScNew, OgesParameters::SLAP, and OgesParameters::solver.

Referenced by canSolveInPlace(), checkGrid(), Ogmg::coarseGridSolverTest(), Ogmg::computeLeftNullVector(), Ogmg::cycle(), formRhsAndSolutionVectors(), and Ogmg::fullMultigrid().

void Oges::makeRightNullVector ( )

protected

References SparseRepForMGF::boundary, c, cg, coeff, MappedGrid::dimension(), getIndex(), SparseRepForMGF::interior, nullRange, OgesParameters::nullVectorScaling, numberOfGrids, parameters, rightNullVector, doubleGridCollectionFunction::sparse, doubleCompositeGridFunction::updateToMatchGrid(), and OgesParameters::userSuppliedCompatibilityConstraint.

Referenced by initialize().

int Oges::matrixVectorMultiply	(	int	n,
		real *	x,
		real *	y
	)

References a, ia, ja, numberOfEquations, numberOfNonzeros, and OGES_MAT_VECT.

Oges & Oges::operator= ( const Oges & x )

References bcData, boundaryConditions, constantCoefficients, and equationToSolve.

int Oges::outputSparseMatrix ( const aString & fileName )

References a, compressedRow, ia, initialized, ja, numberOfEquations, numberOfNonzeros, other, printF(), sparseStorageFormat, and uncompressed.

int Oges::printObsoleteMessage	(	const aString &	routineName,
		int	option = `0`
	)

Referenced by setCompatibilityConstraint(), setConjugateGradientNumberOfIterations(), setConjugateGradientNumberOfSaveVectors(), setConjugateGradientPreconditioner(), setConjugateGradientTolerance(), setConjugateGradientType(), setFillinRatio(), setFillinRatio2(), setHarwellTolerance(), setIterativeImprovement(), setMatrixCutoff(), setNullVectorScaling(), setSolverType(), setSorNumberOfIterations(), setSorOmega(), setSorTolerance(), and setZeroRatio().

int Oges::printStatistics ( FILE * file = stdout ) const

References NULL.

void Oges::privateUpdateToMatchGrid ( )

protected

References cg, GenericGridCollection::numberOfComponentGrids(), numberOfDimensions, GridCollection::numberOfDimensions(), and numberOfGrids.

Referenced by Oges(), setCompositeGrid(), setGrid(), and updateToMatchGrid().

int Oges::put	(	GenericDataBase &	dir,
		const aString &	name
	)		const

virtual

References GenericDataBase::create(), GenericDataBase::setMode(), GenericDataBase::streamOutputMode, and GenericDataBase::virtualConstructor().

void Oges::reference ( const Oges & )

int Oges::set ( OgesParameters::SolverEnum option )

References parameters, and OgesParameters::set().

Referenced by Ogmg::applyOgesSmoother(), checkGrid(), Ogmg::coarseGridSolverTest(), Integrate::computeLeftNullVector(), Ogmg::computeLeftNullVector(), and Integrate::computeWeights().

int Oges::set ( OgesParameters::SolverMethodEnum option )

References parameters, and OgesParameters::set().

int Oges::set ( OgesParameters::MatrixOrderingEnum option )

References parameters, and OgesParameters::set().

int Oges::set ( OgesParameters::PreconditionerEnum option )

References parameters, and OgesParameters::set().

int Oges::set	(	OgesParameters::OptionEnum	option,
		int	value = `0`
	)

References parameters, and OgesParameters::set().

int Oges::set	(	OgesParameters::OptionEnum	option,
		float	value
	)

References parameters, and OgesParameters::set().

int Oges::set	(	OgesParameters::OptionEnum	option,
		double	value
	)

References parameters, and OgesParameters::set().

void Oges::set ( MultigridCompositeGrid & mgcg_ )

Supply a MultigridCompositeGrid (for use with the multigrid solver Ogmg).

Parameters

mgcg	(input) : use this object to hold the multigrid hierarchy.

The MultigridCompositeGrid object can be used to share a multigrid hierarchy amongst different applications and means that the coarse grid levels need only be generated once.

References mgcg, and MultigridCompositeGrid::reference().

int Oges::setCoefficientArray	(	realCompositeGridFunction &	coeff,
		const IntegerArray &	boundaryConditions = `Overture::nullIntArray()`,
		const RealArray &	bcData = `Overture::nullRealArray()`
	)

int Oges::setCoefficientArray	(	realMappedGridFunction &	coeff,
		const IntegerArray &	boundaryConditions = `Overture::nullIntArray()`,
		const RealArray &	bcData = `Overture::nullRealArray()`
	)

References cg, coeff, doubleMappedGridFunction::getComponentBase(), doubleMappedGridFunction::getComponentBound(), doubleMappedGridFunction::getIsACoefficientMatrix(), nullRange, SparseRepForMGF::numberOfComponents, numberOfComponents, doubleCompositeGridFunction::reference(), shouldBeInitialized, doubleMappedGridFunction::sparse, SparseRepForMGF::stencilSize, stencilSize, and doubleCompositeGridFunction::updateToMatchGrid().

int Oges::setCoefficientsAndBoundaryConditions	(	realCompositeGridFunction &	coeff0,
		const IntegerArray &	boundaryConditions,
		const RealArray &	bcData
	)

Supply matrix coefficients and boundary conditions (new way).

This function should be used in the following fashion:

call oges.setGrid(cg) to define a new grid. When using multigrid this will build the multigrid levels.
call this function to define the coefficients and boundary conditions. Do NOT call oges.updateToMatchGrid(cg)
call oges.solve(u,f) to solve the equations. If the equations change but not the grid, call this function again with the new coefficients. If the grid has changed then call both oges.setGrid() and this function again.

Parameters

coeff0	(input): Here are the coefficients. Oges will keep a reference to this grid function.
boundaryConditions(0:1,0:2,numberOfComponentGrids)	(input) : optionally supply boundary conditions. These are currently needed by the multigrid solver.
bcData	: data for the boundary conditions.

References buildEquationSolvers(), equationSolver, initialize(), OgesParameters::multigrid, NULL, parameters, setCoefficientArray(), EquationSolver::setCoefficientsAndBoundaryConditions(), OgesParameters::solver, and solverJob.

void Oges::setCoefficientType ( const coefficientTypes coefficientType )

References coefficientType.

int Oges::setCommandLineArguments	(	int	argc,
		char **	argv
	)

References argc, and argv.

void Oges::setCompatibilityConstraint ( const bool trueOrFalse )

References parameters, printObsoleteMessage(), OgesParameters::set(), shouldBeInitialized, OgesParameters::THEcompatibilityConstraint, and TRUE.

void Oges::setCompositeGrid ( CompositeGrid & cg )

References cg, privateUpdateToMatchGrid(), CompositeGrid::reference(), shouldBeInitialized, and TRUE.

void Oges::setConjugateGradientNumberOfIterations ( const int conjugateGradientNumberOfIterations )

References parameters, printObsoleteMessage(), OgesParameters::set(), and OgesParameters::THEmaximumNumberOfIterations.

void Oges::setConjugateGradientNumberOfSaveVectors ( const int conjugateGradientNumberOfSaveVectors )

References parameters, printObsoleteMessage(), OgesParameters::set(), and OgesParameters::THEgmresRestartLength.

void Oges::setConjugateGradientPreconditioner ( const conjugateGradientPreconditioners conjugateGradientPreconditioner )

References diagonal, incompleteLU, OgesParameters::incompleteLUPreconditioner, parameters, printObsoleteMessage(), OgesParameters::set(), OgesParameters::THEpreconditioner, and OgesParameters::THEsolverMethod.

void Oges::setConjugateGradientTolerance ( const real conjugateGradientTolerance )

References parameters, printObsoleteMessage(), OgesParameters::set(), and OgesParameters::THEtolerance.

void Oges::setConjugateGradientType ( const conjugateGradientTypes conjugateGradientType )

References OgesParameters::biConjugateGradient, biConjugateGradient, OgesParameters::biConjugateGradientSquared, biConjugateGradientSquared, CGStab, OgesParameters::gmres, GMRes, parameters, printObsoleteMessage(), OgesParameters::set(), and OgesParameters::THEsolverMethod.

int Oges::setEquationAndBoundaryConditions	(	OgesParameters::EquationEnum	equation,
		CompositeGridOperators &	op,
		const IntegerArray &	boundaryConditions_,
		const RealArray &	bcData_,
		RealArray &	constantCoeff = `Overture::nullRealArray()`,
		realCompositeGridFunction *	varCoeff = `NULL`
	)

!Define a predefined equation ** this is new ****

Parameters

equation	: defines the equation. If you are supplying a coefficient matrix as a grid function then equation==userDefined. If you want to solve a predefined equation choose equation==laplaceEquation or ...
boundaryConditions(side,axis,grid)	: defines boundary conditions as dirichlet, neumann, mixed, dirichletAndEvenSymmetry, dirichletAndOddSymmetry, extrapolate (defined by the BoundaryConditionEnum).
bcData(0:*,side,axis,grid)	: for a mixed boundary condition a(0)=bcData(0,side,axis,grid). For extrapolation, orderOfExtrapolation=bcData(0,side,axis,grid) where 0 means use the default of orderOfExtrapolation=orderOfAccuracy+1

References BoundaryConditionParameters::a, Overture::abort(), doubleCompositeGridFunction::applyBoundaryConditionCoefficients(), assert, axis2, OgesParameters::axisymmetric, bcData, BCTypes::boundary1, boundaryConditions, buildEquationSolvers(), c, cg, coeff, constantCoefficients, debug, MappedGrid::dimension(), BCTypes::dirichlet, OgesParameters::dirichlet, OgesParameters::dirichletAndEvenSymmetry, OgesParameters::dirichletAndOddSymmetry, MappedGridOperators::divergenceScalarGradient, OgesParameters::divScalarGradHeatEquationOperator, OgesParameters::divScalarGradOperator, dx, equationSolver, equationToSolve, BCTypes::evenSymmetry, BCTypes::extrapolate, OgesParameters::extrapolate, doubleCompositeGridFunction::finishBoundaryConditions(), ForBoundary, getBoundaryIndex(), getIndex(), ParallelUtility::getLocalArrayBounds(), getLocalArrayWithGhostBoundaries(), GenericCompositeGridOperators::getOrderOfAccuracy(), MappedGrid::getRectangularGridParameters(), BoundaryConditionParameters::ghostLineToAssign, MappedGrid::gridIndexRange(), OgesParameters::heatEquationOperator, i2, OgesParameters::isAxisymmetric, MappedGrid::isRectangular(), OgesParameters::laplaceEquation, MappedGridOperators::laplacianOperator, M, MappedGrid::mask(), max(), BCTypes::mixed, OgesParameters::mixed, OgesParameters::multigrid, multiply(), BCTypes::neumann, OgesParameters::neumann, NULL, GenericGridCollection::numberOfComponentGrids(), GridCollection::numberOfDimensions(), MappedGrid::numberOfDimensions(), BCTypes::oddSymmetry, BoundaryConditionParameters::orderOfExtrapolation, OgesParameters::orderOfExtrapolation, parameters, pow(), printF(), REAL_MIN, EquationSolver::setEquationAndBoundaryConditions(), doubleCompositeGridFunction::setIsACoefficientMatrix(), doubleCompositeGridFunction::setOperators(), GenericCompositeGridOperators::setStencilSize(), OgesParameters::solver, stencilSize, OgesParameters::THEcompatibilityConstraint, MappedGrid::THEvertex, MappedGrid::update(), doubleCompositeGridFunction::updateToMatchGrid(), updateToMatchGrid(), OgesParameters::variableHeatEquationOperator, MappedGrid::vertex(), MappedGridOperators::yDerivative, YY, and MappedGridOperators::yyDerivative.

void Oges::setEvaluateJacobian ( const int EvaluateJacobian )

References evaluateJacobian.

int Oges::setExtraEquationValues	(	realCompositeGridFunction &	f,
		real *	value
	)

References assert, equationSolver, NULL, parameters, EquationSolver::setExtraEquationValues(), and OgesParameters::solver.

Referenced by Ogmg::computeLeftNullVector(), and Ogmg::cycle().

void Oges::setFillinRatio ( const real fillinRatio )

References Overture::abort(), and printObsoleteMessage().

void Oges::setFillinRatio2 ( const real fillinRatio2 )

References Overture::abort(), and printObsoleteMessage().

void Oges::setFixupRightHandSide ( const bool trueOrFalse )

void Oges::setGrid	(	CompositeGrid &	cg,
		bool	outOfDate = `true`
	)

References buildEquationSolvers(), cg, equationSolver, mgcg, OgesParameters::multigrid, NULL, parameters, printF(), privateUpdateToMatchGrid(), CompositeGrid::reference(), EquationSolver::setGrid(), MultigridCompositeGrid::setGridIsUpToDate(), shouldBeInitialized, and OgesParameters::solver.

Referenced by Ogmg::buildCoefficientArrays().

void Oges::setGrid	(	MappedGrid &	mg,
		bool	outOfDate = `true`
	)

References buildEquationSolvers(), cg, equationSolver, mgcg, OgesParameters::multigrid, NULL, MappedGrid::numberOfDimensions(), parameters, privateUpdateToMatchGrid(), EquationSolver::setGrid(), MultigridCompositeGrid::setGridIsUpToDate(), shouldBeInitialized, and OgesParameters::solver.

void Oges::setGridName ( const aString & name )

/brief Set the name for the composite grid. /param name (input) : name for the composite grid (used for labels for e.g.)

References gridName.

int Oges::setGridsToUse ( const IntegerArray & gridsToUse )

References cg, min(), GenericGridCollection::numberOfComponentGrids(), useAllGrids, and useThisGrid.

Referenced by Ogmg::applyOgesSmoother().

void Oges::setHarwellTolerance ( const real harwellTolerance )

References Overture::abort(), and printObsoleteMessage().

void Oges::setIterativeImprovement ( const int trueOrFalse )

References Overture::abort(), and printObsoleteMessage().

void Oges::setMatrixCutoff ( const real matrixCutoff )

References Overture::abort(), and printObsoleteMessage().

void Oges::setNullVectorScaling ( const real & scale )

References Overture::abort(), and printObsoleteMessage().

void Oges::setNumberOfComponents ( const int numberOfComponents )

int Oges::setOgesParameters ( const OgesParameters & opar )

References parameters.

Referenced by Ogmg::applyOgesSmoother(), and Ogmg::computeLeftNullVector().

void Oges::setOrderOfAccuracy ( const int order )

void Oges::setPreconditionBoundary ( const int preconditionBoundary )

References preconditionBoundary, shouldBeInitialized, and TRUE.

void Oges::setPreconditionRightHandSide ( const int preconditionRightHandSide )

References preconditionRightHandSide, shouldBeInitialized, and TRUE.

void Oges::setRefactor ( const int refactor )

References refactor.

Referenced by checkGrid().

void Oges::setReorder ( const int reorder )

References reorder.

Referenced by checkGrid().

void Oges::setSolverJob ( const int solverJob )

References solverJob.

void Oges::setSolverName ( const aString & name )

/brief Set the name of this instance of Ogmg (for info in debug files etc.) /param name (input) : name for this instnace of Ogmg.

References solverName.

void Oges::setSolverType ( const solvers solverType )

References bcg, OgesParameters::harwell, harwell, OgesParameters::PETSc, PETSc, printObsoleteMessage(), shouldBeInitialized, OgesParameters::SLAP, SLAP, OgesParameters::THEsolverType, TRUE, OgesParameters::yale, and yale.

void Oges::setSorNumberOfIterations ( const int sorNumberOfIterations )

References Overture::abort(), and printObsoleteMessage().

void Oges::setSorOmega ( const real sorOmega )

References Overture::abort(), and printObsoleteMessage().

void Oges::setSorTolerance ( const real sorTolerance )

References Overture::abort(), and printObsoleteMessage().

void Oges::setTranspose ( const int transpose )

void Oges::setup ( )

protected

void Oges::setZeroRatio ( const real zeroRatio )

References Overture::abort(), and printObsoleteMessage().

real Oges::sizeOf ( FILE * file = NULL ) const

virtual

References ia, max(), and NULL.

int Oges::solve	(	realMappedGridFunction &	u,
		realMappedGridFunction &	f
	)

References cg, doubleMappedGridFunction::getComponentBase(), doubleMappedGridFunction::getComponentBound(), nullRange, doubleMappedGridFunction::positionOfComponent(), R, doubleCompositeGridFunction::reference(), and solve().

int Oges::storeSolutionIntoGridFunction ( )

References assert, CC, cg, CS, ia, GenericGridCollection::numberOfComponentGrids(), numberOfComponents, R, R0, sol, SOL, UG, ul, useAllGrids, and useThisGrid.

Referenced by HarwellEquationSolver::solve(), YaleEquationSolver::solve(), and SlapEquationSolver::solve().

int Oges::storeVector	(	int	n,
		real *	x,
		realCompositeGridFunction &	u
	)

int Oges::update	(	GenericGraphicsInterface &	gi,
		CompositeGrid &	cg
	)

References parameters, and OgesParameters::update().

int Oges::updateToMatchGrid ( CompositeGrid & cg )

References cg, initialize(), privateUpdateToMatchGrid(), CompositeGrid::reference(), and solverJob.

Referenced by Ogmg::applyOgesSmoother(), Integrate::computeLeftNullVector(), Ogmg::computeLeftNullVector(), Integrate::computeWeights(), main(), and setEquationAndBoundaryConditions().

int Oges::updateToMatchGrid ( MappedGrid & mg )

References cg, CompositeGrid::EVERYTHING, MappedGrid::EVERYTHING, GenericGridCollection::geometryHasChanged(), initialize(), MappedGrid::numberOfDimensions(), privateUpdateToMatchGrid(), CompositeGrid::reference(), CompositeGrid::setNumberOfDimensionsAndGrids(), solverJob, and CompositeGrid::updateReferences().

int Oges::writeMatrixGridInformationToFile ( aString fileName )

References SparseRepForMGF::boundary, coeff, equationToIndex(), SparseRepForMGF::extrapolation, SparseRepForMGF::ghost1, SparseRepForMGF::ghost2, SparseRepForMGF::ghost3, SparseRepForMGF::ghost4, i2, SparseRepForMGF::interior, SparseRepForMGF::interpolation, numberOfEquations, SparseRepForMGF::periodic, doubleGridCollectionFunction::sparse, and SparseRepForMGF::unused.

int Oges::writeMatrixToFile ( aString fileName )

References a, compressedRow, ia, initialized, ja, numberOfEquations, numberOfNonzeros, other, printF(), sparseStorageFormat, and uncompressed.

int Oges::writePetscMatrixToFile	(	aString	filename,
		realCompositeGridFunction &	u,
		realCompositeGridFunction &	f
	)

References Overture::abort(), buildEquationSolvers(), equationSolver, NULL, OgesParameters::PETSc, EquationSolver::saveBinaryMatrix(), and OgesParameters::THErescaleRowNorms.

Member Data Documentation

RealArray Oges::a

Referenced by computeResidual(), formMatrix(), generateMatrix(), getMatrix(), matrixVectorMultiply(), outputSparseMatrix(), YaleEquationSolver::solve(), HarwellEquationSolver::solve(), SlapEquationSolver::solve(), and writeMatrixToFile().

real Oges::actualFillinRatio

Referenced by HarwellEquationSolver::solve(), and YaleEquationSolver::solve().

real Oges::actualFillinRatio2

Referenced by HarwellEquationSolver::solve().

real Oges::actualZeroRatio

Referenced by formMatrix().

int Oges::argc

Referenced by setCommandLineArguments(), setup(), and ~Oges().

char** Oges::argv

Referenced by setCommandLineArguments(), setup(), and ~Oges().

RealArray Oges::bcData

protected

Referenced by operator=(), and setEquationAndBoundaryConditions().

IntegerArray Oges::boundaryConditions

protected

Referenced by operator=(), and setEquationAndBoundaryConditions().

intArray* Oges::classify

Referenced by formMatrix(), formRhsAndSolutionVectors(), setup(), and ~Oges().

realCompositeGridFunction Oges::coeff

Referenced by findExtraEquations(), formMatrix(), generateMatrix(), makeRightNullVector(), setCoefficientArray(), setEquationAndBoundaryConditions(), MultigridEquationSolver::solve(), HarwellEquationSolver::solve(), and writeMatrixGridInformationToFile().

realCompositeGridFunction* Oges::coefficientsOfDenseExtraEquations

Referenced by generateMatrix(), initialize(), and setup().

coefficientTypes Oges::coefficientType

Referenced by setCoefficientType().

RealArray Oges::constantCoefficients

protected

Referenced by operator=(), and setEquationAndBoundaryConditions().

EquationSolver* Oges::equationSolver[maximumNumberOfEquationSolvers]

Referenced by buildEquationSolvers(), evaluateExtraEquation(), formMatrix(), generateMatrix(), getExtraEquationValues(), getMaximumResidual(), initialize(), setCoefficientArray(), setCoefficientsAndBoundaryConditions(), setEquationAndBoundaryConditions(), setExtraEquationValues(), setGrid(), setup(), solve(), writePetscMatrixToFile(), and ~Oges().

OgesParameters::EquationEnum Oges::equationToSolve

protected

Referenced by operator=(), setEquationAndBoundaryConditions(), and setup().

int Oges::evaluateJacobian

Referenced by setEvaluateJacobian().

IntegerArray Oges::extraEquationNumber

Referenced by checkGrid(), Integrate::computeLeftNullVector(), determineErrors(), EquationSolver::evaluateExtraEquation(), findExtraEquations(), generateMatrix(), EquationSolver::getExtraEquationValues(), and EquationSolver::setExtraEquationValues().

ListOfRealSerialArray Oges::fl

Referenced by formRhsAndSolutionVectors().

IntegerArray Oges::gridEquationBase

protected

Referenced by equationNo(), equationToIndex(), generateMatrix(), and initialize().

aString Oges::gridName

Referenced by MultigridEquationSolver::MultigridEquationSolver(), setGridName(), and setup().

IntegerArray Oges::ia

Referenced by computeResidual(), formMatrix(), formRhsAndSolutionVectors(), generateMatrix(), getMatrix(), matrixVectorMultiply(), outputSparseMatrix(), YaleEquationSolver::solve(), HarwellEquationSolver::solve(), SlapEquationSolver::solve(), storeSolutionIntoGridFunction(), and writeMatrixToFile().

int Oges::initialized

Referenced by formMatrix(), getMatrix(), initialize(), outputSparseMatrix(), MultigridEquationSolver::setCoefficientsAndBoundaryConditions(), MultigridEquationSolver::setEquationAndBoundaryConditions(), setup(), MultigridEquationSolver::solve(), YaleEquationSolver::solve(), HarwellEquationSolver::solve(), SlapEquationSolver::solve(), and writeMatrixToFile().

IntegerArray Oges::ja

Referenced by computeResidual(), formMatrix(), generateMatrix(), getMatrix(), matrixVectorMultiply(), outputSparseMatrix(), YaleEquationSolver::solve(), HarwellEquationSolver::solve(), SlapEquationSolver::solve(), and writeMatrixToFile().

real Oges::maximumResidual

MultigridCompositeGrid Oges::mgcg

Referenced by buildEquationSolvers(), set(), and setGrid().

int Oges::nda

Referenced by formMatrix(), generateMatrix(), YaleEquationSolver::solve(), HarwellEquationSolver::solve(), and SlapEquationSolver::solve().

int Oges::ndia

Referenced by formMatrix(), YaleEquationSolver::solve(), HarwellEquationSolver::solve(), and SlapEquationSolver::solve().

int Oges::ndja

Referenced by formMatrix(), generateMatrix(), YaleEquationSolver::solve(), HarwellEquationSolver::solve(), and SlapEquationSolver::solve().

int Oges::numberOfComponents

Referenced by determineErrors(), equationNo(), equationToIndex(), formMatrix(), formRhsAndSolutionVectors(), generateMatrix(), initialize(), setCoefficientArray(), setup(), solve(), and storeSolutionIntoGridFunction().

int Oges::numberOfDimensions

Referenced by determineErrors(), getMatrix(), privateUpdateToMatchGrid(), HarwellEquationSolver::solve(), and YaleEquationSolver::solve().

int Oges::numberOfEquations

Referenced by computeResidual(), formMatrix(), generateMatrix(), generateMatrixError(), getMatrix(), matrixVectorMultiply(), outputSparseMatrix(), YaleEquationSolver::solve(), writeMatrixGridInformationToFile(), and writeMatrixToFile().

int Oges::numberOfExtraEquations

Referenced by determineErrors(), EquationSolver::evaluateExtraEquation(), findExtraEquations(), formMatrix(), generateMatrix(), EquationSolver::getExtraEquationValues(), initialize(), EquationSolver::setExtraEquationValues(), and setup().

int Oges::numberOfGrids

Referenced by determineErrors(), equationToIndex(), findExtraEquations(), formMatrix(), formRhsAndSolutionVectors(), generateMatrix(), initialize(), makeRightNullVector(), privateUpdateToMatchGrid(), and setup().

int Oges::numberOfIterations

Referenced by getNumberOfIterations(), setup(), YaleEquationSolver::solve(), MultigridEquationSolver::solve(), HarwellEquationSolver::solve(), and SlapEquationSolver::solve().

int Oges::numberOfNonzeros

Referenced by computeResidual(), formMatrix(), generateMatrix(), getMatrix(), matrixVectorMultiply(), outputSparseMatrix(), YaleEquationSolver::solve(), and writeMatrixToFile().

int Oges::numberOfNonzerosBound

Referenced by formMatrix(), YaleEquationSolver::solve(), and HarwellEquationSolver::solve().

OgesParameters Oges::parameters

Referenced by buildEquationSolvers(), canSolveInPlace(), Integrate::computeWeights(), evaluateExtraEquation(), formMatrix(), formRhsAndSolutionVectors(), generateMatrix(), generateMatrixError(), getCompatibilityConstraint(), getExtraEquationValues(), getMatrix(), getMaximumResidual(), initialize(), isSolverIterative(), makeRightNullVector(), set(), setCoefficientArray(), MultigridEquationSolver::setCoefficientsAndBoundaryConditions(), setCoefficientsAndBoundaryConditions(), setCompatibilityConstraint(), setConjugateGradientNumberOfIterations(), setConjugateGradientNumberOfSaveVectors(), setConjugateGradientPreconditioner(), setConjugateGradientTolerance(), setConjugateGradientType(), MultigridEquationSolver::setEquationAndBoundaryConditions(), setEquationAndBoundaryConditions(), setExtraEquationValues(), MultigridEquationSolver::setGrid(), setGrid(), setOgesParameters(), MultigridEquationSolver::solve(), solve(), and update().

int Oges::preconditionBoundary

Referenced by canSolveInPlace(), setPreconditionBoundary(), and setup().

int Oges::preconditionRightHandSide

Referenced by setPreconditionRightHandSide(), and setup().

bool Oges::recomputePreconditioner

Referenced by setup().

int Oges::refactor

Referenced by getMatrix(), setRefactor(), setup(), HarwellEquationSolver::solve(), YaleEquationSolver::solve(), and SlapEquationSolver::solve().

int Oges::reorder

Referenced by setReorder(), setup(), HarwellEquationSolver::solve(), YaleEquationSolver::solve(), and SlapEquationSolver::solve().

RealArray Oges::rhs

Referenced by formMatrix(), formRhsAndSolutionVectors(), YaleEquationSolver::solve(), HarwellEquationSolver::solve(), and SlapEquationSolver::solve().

realCompositeGridFunction Oges::rightNullVector

Referenced by checkGrid(), EquationSolver::evaluateExtraEquation(), generateMatrix(), initialize(), and makeRightNullVector().

bool Oges::shouldBeInitialized

Referenced by formMatrix(), getMatrix(), initialize(), setCoefficientArray(), MultigridEquationSolver::setCoefficientsAndBoundaryConditions(), setCompatibilityConstraint(), setCompositeGrid(), MultigridEquationSolver::setEquationAndBoundaryConditions(), setGrid(), setPreconditionBoundary(), setPreconditionRightHandSide(), setSolverType(), setup(), HarwellEquationSolver::solve(), YaleEquationSolver::solve(), MultigridEquationSolver::solve(), and SlapEquationSolver::solve().

RealArray Oges::sol

Referenced by formMatrix(), formRhsAndSolutionVectors(), HarwellEquationSolver::solve(), YaleEquationSolver::solve(), SlapEquationSolver::solve(), and storeSolutionIntoGridFunction().

int Oges::solverJob

Referenced by getMatrix(), setCoefficientsAndBoundaryConditions(), setSolverJob(), setup(), and updateToMatchGrid().

aString Oges::solverName

Referenced by MultigridEquationSolver::MultigridEquationSolver(), setSolverName(), and setup().

int Oges::solvingSparseSubset

Referenced by setup(), and YaleEquationSolver::solve().

enum Oges::SparseStorageFormatEnum Oges::sparseStorageFormat

Referenced by formMatrix(), generateMatrix(), outputSparseMatrix(), setup(), and writeMatrixToFile().

int Oges::stencilSize

Referenced by formMatrix(), generateMatrix(), getMatrix(), setCoefficientArray(), setEquationAndBoundaryConditions(), setup(), and YaleEquationSolver::solve().

ListOfRealSerialArray Oges::ul

Referenced by formRhsAndSolutionVectors(), and storeSolutionIntoGridFunction().

realCompositeGridFunction Oges::uLinearized

bool Oges::useAllGrids

protected

Referenced by formMatrix(), formRhsAndSolutionVectors(), generateMatrix(), setCoefficientArray(), setGridsToUse(), setup(), and storeSolutionIntoGridFunction().

IntegerArray Oges::useThisGrid

protected

Referenced by formMatrix(), formRhsAndSolutionVectors(), generateMatrix(), getUseThisGrid(), setCoefficientArray(), setGridsToUse(), and storeSolutionIntoGridFunction().

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

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation