BoundaryExpression Class Reference

#include <BoundaryExpression.hpp>

Inheritance diagram for BoundaryExpression:

Inheritance graph
[legend]
Collaboration diagram for BoundaryExpression:

Collaboration graph
[legend]

List of all members.

Public Types

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

virtual bool hasPOVBoundary () const =0
virtual bool hasPredefinedBoundary () const =0
const
BoundaryExpression::BoundaryType
boundaryType () const
ReferenceCounting< Boundaryboundary ()
 BoundaryExpression (const BoundaryExpression &e)
 BoundaryExpression (const BoundaryExpression::BoundaryType &t)
virtual ~BoundaryExpression ()
const Expression::Typetype () const
 return the type.
virtual void execute ()=0

Protected Member Functions

virtual std::ostream & put (std::ostream &os) const =0
 Writes *this to the output os.
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 Attributes

BoundaryExpression::BoundaryType __boundaryType

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 39 of file BoundaryExpression.hpp.


Member Enumeration Documentation

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

BoundaryExpression::BoundaryExpression ( const BoundaryExpression e  ) 

Copy constructor

Parameters:
e given boundary expression

Definition at line 30 of file BoundaryExpression.cpp.

00031   : Expression(Expression::boundary),
00032     __boundaryType(e.__boundaryType)
00033 {
00034   ;
00035 }

BoundaryExpression::BoundaryExpression ( const BoundaryExpression::BoundaryType t  ) 

Constructor

Parameters:
t the type of the boundary

Definition at line 37 of file BoundaryExpression.cpp.

00038   : Expression(Expression::boundary),
00039     __boundaryType(t)
00040 {
00041   ;
00042 }

BoundaryExpression::~BoundaryExpression (  )  [virtual]

Destructor

Definition at line 44 of file BoundaryExpression.cpp.

00045 {
00046   ;
00047 }


Member Function Documentation

virtual bool BoundaryExpression::hasPOVBoundary (  )  const [pure virtual]

Checks if the boundary has POVRay boundary

Returns:
true if the boundary has POVRay boundary

Implemented in BoundaryExpressionList, BoundaryExpressionPOVRay, BoundaryExpressionReferences, and BoundaryExpressionSurfaceMesh.

virtual bool BoundaryExpression::hasPredefinedBoundary (  )  const [pure virtual]

Checks if the boundary has predefined mesh boundary

Returns:
true if the boundary has predefined mesh boundary

Implemented in BoundaryExpressionList, BoundaryExpressionPOVRay, BoundaryExpressionReferences, and BoundaryExpressionSurfaceMesh.

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

Read only access to the type of the boundary

Returns:
__boundaryType

Definition at line 80 of file BoundaryExpression.hpp.

References __boundaryType.

00081   {
00082     return __boundaryType;
00083   }

ReferenceCounting< Boundary > BoundaryExpression::boundary (  ) 

Access to the boundary

Returns:
__boundary

Definition at line 25 of file BoundaryExpression.cpp.

References __boundary.

Referenced by BoundaryExpressionList::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::ostream& Expression::put ( std::ostream &  os  )  const [protected, pure virtual, inherited]

Writes *this to the output os.

Implemented in BooleanExpression, BoundaryConditionExpressionDirichlet, BoundaryConditionExpressionFourrier, BoundaryConditionExpressionNeumann, BoundaryConditionListExpressionSet, BoundaryExpressionList, BoundaryExpressionPOVRay, BoundaryExpressionReferences, BoundaryExpressionSurfaceMesh, DomainExpressionAnalytic, DomainExpressionSet, DomainExpressionUndefined, DomainExpressionVariable, FieldExpression, FieldExpressionList, FunctionExpression, FunctionExpressionConvection, FunctionExpressionDomainCharacteristic, FunctionExpressionMeshCharacteristic, FunctionExpressionMeshReferences, FunctionExpressionVariable, IFStreamExpression, IFStreamExpressionVariable, InsideExpression, InsideListExpressionAnd, InsideListExpressionOr, InsideListExpressionNot, InsideListExpressionLeaf, IntegratedExpressionUnknown, IntegratedExpressionTest, IntegratedExpressionFunctionExpression, IntegratedOperatorExpressionOrderZero, IntegratedOperatorExpressionGrad, IntegratedOperatorExpressionDx, IStreamExpression, IStreamExpressionList, LinearExpressionElementary, LinearExpressionElementaryTimesFunction, LinearExpressionElementaryTimesReal, MeshExpressionStructured, MeshExpressionSpectral, MeshExpressionSurface, MeshExpressionOctree, MeshExpressionVariable, MeshExpressionRead, MeshExpressionSimplify, MeshExpressionExtract, MeshExpressionTetrahedrize, MeshExpressionTetrahedrizeDomain, MeshExpressionUndefined, MeshExpressionTransform, MeshExpressionPeriodic, MultiLinearExpression, MultiLinearExpressionSum, MultiLinearFormExpression, MultiLinearFormSumExpression, OFStreamExpression, OFStreamExpressionVariable, OptionExpression, OStreamExpression, OStreamExpressionList, PDEEquationExpression, PDEScalarOperatorExpressionDivMuGrad, PDEScalarOperatorExpressionOrderZero, PDEScalarOperatorExpressionOrderOne, PDEVectorialOperatorExpressionOrderOne, PDEVectorialOperatorExpressionOrderTwo, PDEOperatorSumExpression, PDEProblemExpressionDescription, PDESystemExpression, RealExpression, SceneExpressionPOVRay, SceneExpressionVariable, SceneExpressionTransform, SceneExpressionUndefined, SolutionExpressionVariable, SolutionExpressionUndefined, SolverExpression, SolverOptionsExpression, StringExpression, SubOptionExpressionString, SubOptionExpressionReal, SubOptionListExpression, TestFunctionExpressionList, UnknownExpression, UnknownListExpressionSet, VariationalDirichletListExpression, VariationalFormulaExpression, VariationalMuGradUGradVExpression, VariationalAlphaDxUDxVExpression, VariationalNuUdxVExpression, VariationalNuDxUVExpression, VariationalAlphaUVExpression, VariationalFVExpression, VariationalFdxGVExpression, VariationalFdxVExpression, VariationalFgradGgradVExpression, VariationalProblemExpression, and Vector3Expression.

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   }

virtual void Expression::execute (  )  [pure virtual, inherited]

Executes the expression.

Implemented in BooleanExpressionValue, BooleanExpressionUnaryOperator< F >, BooleanExpressionCompareOperator< B >, BooleanExpressionBinaryOperator< B >, BoundaryConditionExpressionDirichlet, BoundaryConditionExpressionFourrier, BoundaryConditionExpressionNeumann, BoundaryConditionListExpressionSet, BoundaryExpressionList, BoundaryExpressionPOVRay, BoundaryExpressionReferences, BoundaryExpressionSurfaceMesh, DomainExpressionAnalytic, DomainExpressionSet, DomainExpressionUndefined, DomainExpressionVariable, FieldExpression, FieldExpressionList, FunctionExpressionBinaryOperation, FunctionExpressionCFunction, FunctionExpressionComposed, FunctionExpressionConstant, FunctionExpressionConvection, FunctionExpressionDerivative, FunctionExpressionDG, FunctionExpressionDomainCharacteristic, FunctionExpressionFEM, FunctionExpressionIntegrate, FunctionExpressionLinearBasis, FunctionExpressionMeshCharacteristic, FunctionExpressionMeshReferences, FunctionExpressionNormalComponent, FunctionExpressionNot, FunctionExpressionObjectCharacteristic, FunctionExpressionRead, FunctionExpressionSpectral, FunctionExpressionUnaryMinus, FunctionExpressionValue, FunctionExpressionVariable, IFStreamExpressionUndefined, IFStreamExpressionValue, IFStreamExpressionVariable, InsideExpression, InsideListExpression, IntegratedExpressionUnknown, IntegratedExpressionTest, IntegratedExpressionFunctionExpression, IntegratedOperatorExpressionOrderZero, IntegratedOperatorExpressionGrad, IntegratedOperatorExpressionDx, IStreamExpression, IStreamExpressionList, LinearExpressionElementary, LinearExpressionElementaryTimesFunction, LinearExpressionElementaryTimesReal, MeshExpressionStructured, MeshExpressionSpectral, MeshExpressionSurface, MeshExpressionOctree, MeshExpressionVariable, MeshExpressionRead, MeshExpressionSimplify, MeshExpressionExtract, MeshExpressionTetrahedrize, MeshExpressionTetrahedrizeDomain, MeshExpressionUndefined, MeshExpressionTransform, MeshExpressionPeriodic, MultiLinearExpression, MultiLinearExpressionSum, MultiLinearFormExpression, MultiLinearFormSumExpression, OFStreamExpressionUndefined, OFStreamExpressionValue, OFStreamExpressionVariable, OptionExpression, OStreamExpression, OStreamExpressionList, PDEEquationExpression, PDEOperatorExpression, PDEOperatorSumExpression, PDEProblemExpressionDescription, PDESystemExpression, RealExpressionValue, RealExpressionBoolean, RealExpressionVariable, RealExpressionFunctionEvaluate, RealExpressionIntegrate, RealExpressionMinMax, RealExpressionPreIncrement, RealExpressionPostIncrement, RealExpressionPreDecrement, RealExpressionPostDecrement, RealExpressionCFunction, RealExpressionUnaryOperator< F >, RealExpressionBinaryOperator< B >, SceneExpressionPOVRay, SceneExpressionVariable, SceneExpressionTransform, SceneExpressionUndefined, SolutionExpressionVariable, SolutionExpressionUndefined, SolverExpression, SolverOptionsExpression, StringExpressionValue, StringExpressionConcat, StringExpressionReal, StringExpressionVariable, SubOptionExpressionString, SubOptionExpressionReal, SubOptionListExpression, TestFunctionExpressionList, UnknownExpression, UnknownListExpressionSet, VariationalDirichletListExpression, VariationalFormulaExpression, VariationalBilinearOperatorExpression, VariationalLinearOperatorExpression, VariationalProblemExpression, Vector3ExpressionValue, Vector3ExpressionTimesScalar, Vector3ExpressionVariable, and Vector3ExpressionBinaryOperator< B >.

Referenced by FunctionExpressionMeshReferences::ReferencesSet::execute().


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

type of the boundary

Definition at line 54 of file BoundaryExpression.hpp.

Referenced by boundaryType().


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

Generated on Wed Nov 19 00:04:51 2008 for FreeFEM3D (aka ff3d) by  doxygen 1.5.6