InsideListExpression Class Reference

#include <InsideListExpression.hpp>

Inheritance diagram for InsideListExpression:

Inheritance graph
[legend]
Collaboration diagram for InsideListExpression:

Collaboration graph
[legend]

List of all members.

Public Types

enum  NodeType { NodeAnd, NodeOr, NodeNot, NodeLeaf }
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

void execute ()
virtual void subExecute ()=0
void checkReferencesUniqueness ()
virtual void addReferences (InsideListExpression::ReferenceList &references)=0
virtual ReferenceCounting< Object > objects (const Scene &S)=0
 InsideListExpression (const InsideListExpression::NodeType type)
 InsideListExpression (const InsideListExpression &ie)
virtual ~InsideListExpression ()
const Expression::Type & type () const
 return the type.

Protected Types

typedef std::map< TinyVector
< 3, real_t >, size_t > 		ReferenceList

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)

Private Attributes

const NodeType __type

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 41 of file InsideListExpression.hpp.

Member Typedef Documentation

typedef std::map<TinyVector<3, real_t>, size_t> InsideListExpression::ReferenceList [protected]

Definition at line 46 of file InsideListExpression.hpp.

Member Enumeration Documentation

enum InsideListExpression::NodeType

Enumerator:
NodeAnd 
NodeOr 
NodeNot 
NodeLeaf 

Definition at line 49 of file InsideListExpression.hpp.

00049                 {
00050     NodeAnd,
00051     NodeOr,
00052     NodeNot,
00053     NodeLeaf
00054   };

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

InsideListExpression::InsideListExpression ( const InsideListExpression::NodeType  type  )  [inline]

node constructor

Parameters:
type 

Definition at line 121 of file InsideListExpression.hpp.

00122     : Expression(Expression::insideListExpression),
00123       __type(type)
00124   {
00125     ;
00126   }

InsideListExpression::InsideListExpression ( const InsideListExpression &  ie  )  [inline]

Copy constructor

Parameters:
ie 

Definition at line 134 of file InsideListExpression.hpp.

00135     : Expression(ie),
00136       __type(ie.__type)
00137   {
00138     ;
00139   }

virtual InsideListExpression::~InsideListExpression (  )  [inline, virtual]

Destructor

Definition at line 146 of file InsideListExpression.hpp.

00147   {
00148     ;
00149   }

Member Function Documentation

void InsideListExpression::execute (  )  [inline, virtual]

overloading of Expression::execute()

Implements Expression.

Definition at line 65 of file InsideListExpression.hpp.

References checkReferencesUniqueness(), and subExecute().

00066   {
00067     this->subExecute();
00068     this->checkReferencesUniqueness();
00069   }

Here is the call graph for this function:

virtual void InsideListExpression::subExecute (  )  [pure virtual]

helps to break the execution into parts

Implemented in InsideListExpressionAnd, InsideListExpressionOr, InsideListExpressionNot, and InsideListExpressionLeaf.

Referenced by execute().

void InsideListExpression::checkReferencesUniqueness (  )  [inline]

Checks that all given references are given only once

Definition at line 81 of file InsideListExpression.hpp.

References addReferences(), ErrorHandler::normal, and stringify().

Referenced by execute().

00082   {
00083     InsideListExpression::ReferenceList references;
00084     this->addReferences(references);
00085     for (ReferenceList::const_iterator i = references.begin();
00086          i != references.end(); ++i) {
00087       if ((*i).second > 1) {
00088         std::string errorMsg
00089           = "POV-Ray reference "+stringify((*i).first)+" is used "
00090                  +stringify((*i).second)+" times in the domain definition\n"
00091             "only once is allowed";
00092         throw ErrorHandler(__FILE__,__LINE__,
00093                            errorMsg,
00094                            ErrorHandler::normal);
00095       }
00096     }
00097   }

Here is the call graph for this function:

virtual void InsideListExpression::addReferences ( InsideListExpression::ReferenceList &  references  )  [pure virtual]

Fills a list which counts POV-Ray references

Parameters:
references the references and their number of instance

Implemented in InsideListExpressionAnd, InsideListExpressionOr, InsideListExpressionNot, and InsideListExpressionLeaf.

Referenced by checkReferencesUniqueness().

virtual ReferenceCounting<Object> InsideListExpression::objects ( const Scene &  S  )  [pure virtual]

Evaluates the domain shape

Returns:
a shape.

Implemented in InsideListExpressionAnd, InsideListExpressionOr, InsideListExpressionNot, and InsideListExpressionLeaf.

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   }

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

const NodeType InsideListExpression::__type [private]

node type

Reimplemented from Expression.

Definition at line 57 of file InsideListExpression.hpp.

The documentation for this class was generated from the following file:
Generated on Wed Nov 19 00:07:49 2008 for FreeFEM3D (aka ff3d) by  doxygen 1.5.6