BoundaryExpressionList Class Reference

#include <BoundaryExpressionList.hpp>

Inheritance diagram for BoundaryExpressionList:

Collaboration diagram for BoundaryExpressionList:

List of all members.

Public Types

typedef std::list
< ReferenceCounting
< BoundaryExpression > > List

enum BoundaryType {
  undefined, surfaceMesh, povray, references,
  list, variable
}

enum Type {
  boolean, boundary, boundaryCondition, boundaryConditionList,
  domain, field, fieldlist, function,
  ifstreamexpression, integrated, integratedOperator, insideExpression,
  insideListExpression, istreamexpression, istreamExpressionList, linearExp,
  mesh, multiLinearExp, multiLinearExpSum, multiLinearForm,
  multiLinearFormSum, ofstreamexpression, option, ostreamexpression,
  ostreamExpressionList, pdeEquation, pdeOperator, pdeOperatorSum,
  pdeProblem, problem, real, scene,
  solver, solverOptions, string, subOption,
  subOptionList, testFunctionList, unknown, unknownList,
  variationalFormula, variationalBilinearOperator, variationalLinearOperator, variationalDirichlet,
  vector3
}

Public Member Functions

bool hasPOVBoundary () const

bool hasPredefinedBoundary () const

void execute ()

void add (ReferenceCounting< BoundaryExpression > boundary)

BoundaryExpressionList ()

BoundaryExpressionList (const BoundaryExpressionList &l)

~BoundaryExpressionList ()

const
BoundaryExpression::BoundaryType & boundaryType () const

ReferenceCounting< Boundary > boundary ()

const Expression::Type & type () const

return the type.

Protected Member Functions

virtual std::istream & _get (std::istream &is)

Read *this to the input is.

Static Protected Member Functions

static Expression::Type getType (ReferenceCounting< Expression > e1, ReferenceCounting< Expression > e2)

Protected Attributes

ReferenceCounting< Boundary > __boundary

Private Member Functions

std::ostream & put (std::ostream &os) const

Private Attributes

List __boundaries

Friends

std::ostream & operator<< (std::ostream &os, const Expression &e)

this function allows to output expressions.

std::istream & operator>> (std::istream &is, Expression &e)

this function allows to read expressions from streams

Detailed Description

Definition at line 34 of file BoundaryExpressionList.hpp.

Member Typedef Documentation

typedef std::list<ReferenceCounting<BoundaryExpression> > BoundaryExpressionList::List

Definition at line 38 of file BoundaryExpressionList.hpp.

Member Enumeration Documentation

enum BoundaryExpression::BoundaryType [inherited]

Enumerator:

undefined
surfaceMesh
povray
references
list
variable

Definition at line 43 of file BoundaryExpression.hpp.

00043                     {
00044     undefined,
00045     surfaceMesh,
00046     povray,
00047     references,
00048     list,
00049     variable
00050   };

enum Expression::Type [inherited]

Enumerator:

boolean
boundary
boundaryCondition
boundaryConditionList
domain
field
fieldlist
function
ifstreamexpression
integrated
integratedOperator
insideExpression
insideListExpression
istreamexpression
istreamExpressionList
linearExp
mesh
multiLinearExp
multiLinearExpSum
multiLinearForm
multiLinearFormSum
ofstreamexpression
option
ostreamexpression
ostreamExpressionList
pdeEquation
pdeOperator
pdeOperatorSum
pdeProblem
problem
real
scene
solver
solverOptions
string
subOption
subOptionList
testFunctionList
unknown
unknownList
variationalFormula
variationalBilinearOperator
variationalLinearOperator
variationalDirichlet
vector3

Reimplemented in IFStreamExpression, OFStreamExpression, and UnknownExpression.

Definition at line 42 of file Expression.hpp.

00042              {
00043     boolean,
00044     boundary,
00045     boundaryCondition,
00046     boundaryConditionList,
00047 
00048     domain,
00049 
00050     field,
00051     fieldlist,
00052     function,
00053 
00054     ifstreamexpression,
00055     integrated,
00056     integratedOperator,
00057     insideExpression,
00058     insideListExpression,
00059     istreamexpression,
00060     istreamExpressionList,
00061 
00062     linearExp,
00063 
00064     mesh,
00065     multiLinearExp,
00066     multiLinearExpSum,
00067     multiLinearForm,
00068     multiLinearFormSum,
00069 
00070     ofstreamexpression,
00071     option,
00072     ostreamexpression,
00073     ostreamExpressionList,
00074 
00075     pdeEquation,
00076     pdeOperator,
00077     pdeOperatorSum,
00078     pdeProblem,
00079     problem,
00080 
00081     real,
00082 
00083     scene,
00084     solver,
00085     solverOptions,
00086     string,
00087     subOption,
00088     subOptionList,
00089 
00090     testFunctionList,
00091 
00092     unknown,
00093     unknownList,
00094 
00095     variationalFormula,
00096     variationalBilinearOperator,
00097     variationalLinearOperator,
00098     variationalDirichlet,
00099     vector3
00100   };

Constructor & Destructor Documentation

BoundaryExpressionList::BoundaryExpressionList ( )

Constructor

Definition at line 53 of file BoundaryExpressionList.cpp.

00054   : BoundaryExpression(BoundaryExpression::list)
00055 {
00056   ;
00057 }

BoundaryExpressionList::BoundaryExpressionList ( const BoundaryExpressionList & l )

Copy constructor

Parameters:

l

given list

Definition at line 60 of file BoundaryExpressionList.cpp.

00061   : BoundaryExpression(l),
00062     __boundaries(l.__boundaries)
00063 {
00064   ;
00065 }

BoundaryExpressionList::~BoundaryExpressionList ( )

Destructor

Definition at line 68 of file BoundaryExpressionList.cpp.

00069 {
00070   ;
00071 }

Member Function Documentation

std::ostream & BoundaryExpressionList::put ( std::ostream & os ) const [private, virtual]

Writes the list of boundary expressions to a stream

Parameters:

os

the given stream

Returns:: os

Implements Expression.

Definition at line 40 of file BoundaryExpressionList.cpp.

References __boundaries.

00041 {
00042   for (List::const_iterator i = __boundaries.begin();
00043        i != __boundaries.end(); ++i) {
00044     if (i != __boundaries.begin()) {
00045       os << ',';
00046     }
00047     os << (**i);
00048   }
00049   return os;
00050 }

bool BoundaryExpressionList::hasPOVBoundary ( ) const [inline, virtual]

Checks if one of the boundaries is a POVRay boundary

Returns:: true if one of the boundaries contains a POVRay boundary

Implements BoundaryExpression.

Definition at line 58 of file BoundaryExpressionList.hpp.

References __boundaries.

00059   {
00060     for (List::const_iterator i = __boundaries.begin();
00061          i != __boundaries.end(); ++i) {
00062       if ((*i)->hasPOVBoundary()) {
00063         return true;
00064       }
00065     }
00066     return false;
00067   }

bool BoundaryExpressionList::hasPredefinedBoundary ( ) const [inline, virtual]

Checks if one of the boundaries is defined on a predefined external mesh

Returns:: true if one of the boundaries contains a predefined external mesh

Implements BoundaryExpression.

Definition at line 76 of file BoundaryExpressionList.hpp.

References __boundaries.

00077   {
00078     for (List::const_iterator i = __boundaries.begin();
00079          i != __boundaries.end(); ++i) {
00080       if ((*i)->hasPredefinedBoundary()) {
00081         return true;
00082       }
00083     }
00084     return false;
00085   }

void BoundaryExpressionList::execute ( ) [virtual]

Executes the expression

Implements Expression.

Definition at line 26 of file BoundaryExpressionList.cpp.

References __boundaries, BoundaryExpression::__boundary, and BoundaryList::add().

00027 {
00028   BoundaryList* b = new BoundaryList();
00029 
00030   for(List::iterator i = __boundaries.begin();
00031       i != __boundaries.end(); ++i) {
00032     (**i).execute();
00033     b->add((**i).boundary());
00034   }
00035   __boundary = b;
00036 }

Here is the call graph for this function:

void BoundaryExpressionList::add ( ReferenceCounting< BoundaryExpression > boundary ) [inline]

Adds a boundary to the list

Parameters:

boundary

the bondary expression to add

Definition at line 98 of file BoundaryExpressionList.hpp.

References __boundaries, and BoundaryExpression::boundary().

00099   {
00100     __boundaries.push_back(boundary);
00101   }

Here is the call graph for this function:

const BoundaryExpression::BoundaryType& BoundaryExpression::boundaryType ( ) const [inline, inherited]

Read only access to the type of the boundary

Returns:: __boundaryType

Definition at line 80 of file BoundaryExpression.hpp.

References BoundaryExpression::__boundaryType.

00081   {
00082     return __boundaryType;
00083   }

ReferenceCounting< Boundary > BoundaryExpression::boundary ( ) [inherited]

Access to the boundary

Returns:: __boundary

Definition at line 25 of file BoundaryExpression.cpp.

References BoundaryExpression::__boundary.

Referenced by add().

00026 {
00027   return __boundary;
00028 }

static Expression::Type Expression::getType	(	ReferenceCounting< Expression >	e1,
		ReferenceCounting< Expression >	e2
	)			`[inline, static, protected, inherited]`

Traits conversion of types.

Todo:: IMPLEMENT IT.

Definition at line 112 of file Expression.hpp.

References Expression::real.

00114   {
00115     return Expression::real;
00116   }

virtual std::istream& Expression::_get ( std::istream & is ) [inline, protected, virtual, inherited]

Read *this to the input is.

Reimplemented in IStreamExpressionList, and RealExpressionVariable.

Definition at line 122 of file Expression.hpp.

References ErrorHandler::normal.

00123   {
00124     throw ErrorHandler(__FILE__,__LINE__,
00125                        "operator >> is not supported for this expression",
00126                        ErrorHandler::normal);
00127     return is;
00128   }

const Expression::Type& Expression::type ( ) const [inline, inherited]

return the type.

Reimplemented in FunctionExpression.

Definition at line 132 of file Expression.hpp.

References Expression::__type.

Referenced by MeshExpressionExtract::execute().

00133   {
00134     return __type;
00135   }

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const Expression &	e
	)			`[friend, inherited]`

this function allows to output expressions.

Definition at line 143 of file Expression.hpp.

00144   {
00145     return e.put(os);
00146   }

std::istream& operator>>	(	std::istream &	is,
		Expression &	e
	)			`[friend, inherited]`

this function allows to read expressions from streams

Definition at line 149 of file Expression.hpp.

00150   {
00151     return e._get(is);
00152   }

Member Data Documentation

List BoundaryExpressionList::__boundaries [private]

list of boundary expressions

Definition at line 41 of file BoundaryExpressionList.hpp.

Referenced by add(), execute(), hasPOVBoundary(), hasPredefinedBoundary(), and put().

ReferenceCounting<Boundary> BoundaryExpression::__boundary [protected, inherited]

Reference to the boundary

Definition at line 58 of file BoundaryExpression.hpp.

Referenced by BoundaryExpression::boundary(), BoundaryExpressionSurfaceMesh::execute(), BoundaryExpressionReferences::execute(), BoundaryExpressionPOVRay::execute(), and execute().

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


Public Types
typedef std::list < ReferenceCounting < BoundaryExpression > >	List
enum	BoundaryType { undefined, surfaceMesh, povray, references, list, variable }
enum	Type { boolean, boundary, boundaryCondition, boundaryConditionList, domain, field, fieldlist, function, ifstreamexpression, integrated, integratedOperator, insideExpression, insideListExpression, istreamexpression, istreamExpressionList, linearExp, mesh, multiLinearExp, multiLinearExpSum, multiLinearForm, multiLinearFormSum, ofstreamexpression, option, ostreamexpression, ostreamExpressionList, pdeEquation, pdeOperator, pdeOperatorSum, pdeProblem, problem, real, scene, solver, solverOptions, string, subOption, subOptionList, testFunctionList, unknown, unknownList, variationalFormula, variationalBilinearOperator, variationalLinearOperator, variationalDirichlet, vector3 }
Public Member Functions
bool	hasPOVBoundary () const
bool	hasPredefinedBoundary () const
void	execute ()
void	add (ReferenceCounting< BoundaryExpression > boundary)
	BoundaryExpressionList ()
	BoundaryExpressionList (const BoundaryExpressionList &l)
	~BoundaryExpressionList ()
const BoundaryExpression::BoundaryType &	boundaryType () const
ReferenceCounting< Boundary >	boundary ()
const Expression::Type &	type () const
	return the type.
Protected Member Functions
virtual std::istream &	_get (std::istream &is)
	Read *this to the input is.
Static Protected Member Functions
static Expression::Type	getType (ReferenceCounting< Expression > e1, ReferenceCounting< Expression > e2)
Protected Attributes
ReferenceCounting< Boundary >	__boundary
Private Member Functions
std::ostream &	put (std::ostream &os) const
Private Attributes
List	__boundaries
Friends
std::ostream &	operator<< (std::ostream &os, const Expression &e)
	this function allows to output expressions.
std::istream &	operator>> (std::istream &is, Expression &e)
	this function allows to read expressions from streams