SAMRAI::solv::PVodeTrioAbstractVector Class Reference

#include <source/solvers/packages/pvode_trio/vector/PVodeTrioAbstractVector.h>

Inheritance diagram for SAMRAI::solv::PVodeTrioAbstractVector:

[legend]List of all members.


Public Member Functions
	PVodeTrioAbstractVector ()
virtual	~PVodeTrioAbstractVector ()
virtual PVodeTrioAbstractVector *	makeNewVector ()=0
virtual void	freeVector ()=0
virtual void	setToScalar (const double c)=0
virtual void	scaleVector (const PVodeTrioAbstractVector *x, const double c)=0
virtual void	setLinearSum (const double a, const PVodeTrioAbstractVector x, const double b, const PVodeTrioAbstractVector y)=0
virtual void	pointwiseMultiply (const PVodeTrioAbstractVector x, const PVodeTrioAbstractVector y)=0
virtual void	pointwiseDivide (const PVodeTrioAbstractVector x, const PVodeTrioAbstractVector y)=0
virtual void	setAbs (const PVodeTrioAbstractVector *x)=0
virtual void	pointwiseReciprocal (const PVodeTrioAbstractVector *x)=0
virtual void	addScalar (const PVodeTrioAbstractVector *x, const double b)=0
virtual double	dotWith (const PVodeTrioAbstractVector *x) const =0
virtual double	maxNorm () const =0
virtual double	L1Norm () const =0
virtual double	weightedL2Norm (const PVodeTrioAbstractVector *x) const =0
virtual double	weightedRMSNorm (const PVodeTrioAbstractVector *x) const =0
virtual double	vecMin () const =0
virtual int	constrProdPos (const PVodeTrioAbstractVector *x) const =0
virtual void	compareToScalar (const PVodeTrioAbstractVector *x, const double c)=0
virtual int	testReciprocal (const PVodeTrioAbstractVector *x)=0
virtual void	printVector () const =0

Detailed Description

Class solv::PVodeTrioAbstractVector is an abstract base class that declares operations provided by any { C++} class that may be used as the vector kernel by the PVodeTrio nonlinear solver package. PVodeTrio allows arbitrarily defined vectors to be used within it as long as the proper collection of operations are provided. The intent of this base class to provide the interface for one's own vector kernel. One implements a subclass that provides the functions declared herein as pure virtual and which provides necessary vector data structures. Note that the virtual members of this class are all protected. They should not be used outside of a subclass of this class.

PVodeTrio was developed in the Center for Applied Scientific Computing (CASC) at Lawrence Livermore National Laboratory (LLNL). For more information about PVodeTrio, see A.G. Taylor and A.C. Hindmarsh, "User documentation for PVodeTrio, a nonlinear solver for sequential and parallel computers", UCRL-ID-131185, Lawrence Livermore National Laboratory, 1998.

Important notes:

(1) The user-supplied vector subclass should only inherit from this base class. It MUST NOT employ multiple inheritance so that problems with casting from a base class pointer to a subclass pointer and the use of virtual functions works properly.
(2) The user-supplied subclass that implements the vector data structures and operations is responsible for all parallelism, I/O, etc. associated with the vector objects. PVodeTrio is implemented using a SPMD programming model. It has no knowlege of the structure of the vector data, nor the implementations of the individual vector routines.
(3) We assume the vector data is { double}, which is the default for PVodeTrio.

See also:: solv::PVodeTrioSolver

Constructor & Destructor Documentation

SAMRAI::solv::PVodeTrioAbstractVector::PVodeTrioAbstractVector ( )

Uninteresting constructor and destructor for solv::PVodeTrioAbstractVector.

SAMRAI::solv::PVodeTrioAbstractVector::~PVodeTrioAbstractVector ( ) [virtual]

Member Function Documentation

virtual PVodeTrioAbstractVector* SAMRAI::solv::PVodeTrioAbstractVector::makeNewVector ( ) [pure virtual]

Clone the vector structure and allocate storage for the vector data. Then, return a pointer to the new vector instance. Note that the new vector object must be distinct from the original. This function is distinct from the vector constructor since it will be called from within PVodeTrio to allocate vectors during the nonlinear solution process. The original solution vector must be setup by the user's application code.

virtual void SAMRAI::solv::PVodeTrioAbstractVector::freeVector ( ) [pure virtual]

Destroy vector structure and its storage. This function is distinct from the destructor since it will be called from within PVodeTrio to deallocate vectors during the nonlinear solution process.

virtual void SAMRAI::solv::PVodeTrioAbstractVector::setToScalar ( const double c ) [pure virtual]

Initialize all entries of this vector object to scalar $c$ .

virtual void SAMRAI::solv::PVodeTrioAbstractVector::scaleVector ( const PVodeTrioAbstractVector * x,

const double c

) [pure virtual]

Set this vector object to scalar $c x$ , where $c$ is a scalar and x is another vector.

virtual void SAMRAI::solv::PVodeTrioAbstractVector::setLinearSum ( const double a,

const PVodeTrioAbstractVector * x,

const double b,

const PVodeTrioAbstractVector * y

) [pure virtual]

Set this vector object to $a x + b y$ , where $a, b$ are scalars and $x, y$ are vectors.

virtual void SAMRAI::solv::PVodeTrioAbstractVector::pointwiseMultiply ( const PVodeTrioAbstractVector * x,

const PVodeTrioAbstractVector * y

) [pure virtual]

Set each entry of this vector: $v_i = x_i y_i$ , where $x_i, y_i$ are entries in vectors $x$ and $y$ .

virtual void SAMRAI::solv::PVodeTrioAbstractVector::pointwiseDivide ( const PVodeTrioAbstractVector * x,

const PVodeTrioAbstractVector * y

) [pure virtual]

Set each entry of this vector: $v_i = x_i / y_i$ , where $x_i, y_i$ are entries in vectors $x$ and $y$ . Based on the PVodeTrio vector implementation, it is not necessary to check for division by zero.

virtual void SAMRAI::solv::PVodeTrioAbstractVector::setAbs ( const PVodeTrioAbstractVector * x ) [pure virtual]

Set each entry of this vector to the absolute value of the corresponding entry in vector $x$ .

virtual void SAMRAI::solv::PVodeTrioAbstractVector::pointwiseReciprocal ( const PVodeTrioAbstractVector * x ) [pure virtual]

Set each entry of this vector: $v_i = 1 / x_i$ , where $x_i$ is an entry entry in vector $x$ . Based on the PVodeTrio vector implementation, it is not necessary to no check for division by zero.

virtual void SAMRAI::solv::PVodeTrioAbstractVector::addScalar ( const PVodeTrioAbstractVector * x,

const double b

) [pure virtual]

Set each entry of this vector to the corresponding entry in vector $x$ plus the scalar $b$ .

virtual double SAMRAI::solv::PVodeTrioAbstractVector::dotWith ( const PVodeTrioAbstractVector * x ) const [pure virtual]

Return the dot product of this vector and the argument vector $x$ .

virtual double SAMRAI::solv::PVodeTrioAbstractVector::maxNorm ( ) const [pure virtual]

Return the max norm of this vector.

virtual double SAMRAI::solv::PVodeTrioAbstractVector::L1Norm ( ) const [pure virtual]

Return the $L_1$ norm of this vector.

virtual double SAMRAI::solv::PVodeTrioAbstractVector::weightedL2Norm ( const PVodeTrioAbstractVector * x ) const [pure virtual]

Return the weighted- $L_2$ norm of this vector using the vector $x$ as the weighting vector.

virtual double SAMRAI::solv::PVodeTrioAbstractVector::weightedRMSNorm ( const PVodeTrioAbstractVector * x ) const [pure virtual]

Return the weighted root mean squared norm of this vector using the vector $x$ as the weighting vector.

virtual double SAMRAI::solv::PVodeTrioAbstractVector::vecMin ( ) const [pure virtual]

Return the minimum entry of this vector.

virtual int SAMRAI::solv::PVodeTrioAbstractVector::constrProdPos ( const PVodeTrioAbstractVector * x ) const [pure virtual]

Return $0$ if $x_i \neq 0$ and $x_i z_i \leq 0$ , for some $i$ . Here $z_i$ is an element of this vector. Otherwise, return $1$ .

virtual void SAMRAI::solv::PVodeTrioAbstractVector::compareToScalar ( const PVodeTrioAbstractVector * x,

const double c

) [pure virtual]

Set each entry in this vector based on the vector $x$ as follows: if $\mid x_i \mid \geq c$ , then $v_i = 1$ , else $v_i = 0$ .

virtual int SAMRAI::solv::PVodeTrioAbstractVector::testReciprocal ( const PVodeTrioAbstractVector * x ) [pure virtual]

Set each entry of this vector: $v_i = 1 / x_i$ , where $x_i$ is an entry entry in the vector $x$ , unless $x_i = 0$ . If , then return $0$ . Otherwise, $1$ is returned.

virtual void SAMRAI::solv::PVodeTrioAbstractVector::printVector ( ) const [pure virtual]

Print the vector data to the output stream used by the subclass print routine.

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

source/solvers/packages/pvode_trio/vector/PVodeTrioAbstractVector.h
source/solvers/packages/pvode_trio/vector/PVodeTrioAbstractVector.C

Generated on Fri Dec 2 11:30:31 2005 for SAMRAI by

1.4.2

SAMRAI::solv::PVodeTrioAbstractVector Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation