VariationalFVExpression Class Reference

describes $\int fv$ More...

#include <VariationalOperatorExpression.hpp>

Inheritance diagram for VariationalFVExpression:

Inheritance graph
[legend]
Collaboration diagram for VariationalFVExpression:

Collaboration graph
[legend]

List of all members.

Public Types

enum  OperatorType { FV, FdxGV, FdxV, FgradGgradV }
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

ReferenceCounting
< FunctionExpression > 		f ()
 VariationalFVExpression (ReferenceCounting< FunctionExpression > f, const std::string &testFunctionName, const VariationalOperator::Property &testFunctionProperty, ReferenceCounting< BoundaryExpression > border=0)
 VariationalFVExpression (const VariationalFVExpression &V)
 ~VariationalFVExpression ()
ReferenceCounting
< BoundaryExpression > 		border () const
void execute ()
OperatorType operatorType ()
const std::string & testFunctionName () const
const Expression::Type & type () const
 return the type.

Protected Member Functions

std::string __propertyBeginWrite (const VariationalOperator::Property &property) const
std::string __propertyEndWrite (const VariationalOperator::Property &property) const
std::string __testTypeBeginWrite () const
std::string __testTypeEndWrite () const
char __directionName (const size_t &i) const
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

const std::string __testFunctionName
const VariationalOperator::Property __testFunctionProperty

Private Member Functions

void __executeRemaining ()
bool __hasBoundaryExpression () const
std::ostream & put (std::ostream &os) const

Private Attributes

ReferenceCounting
< FunctionExpression > 		__f

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

describes $\int fv$

Author:
Stephane Del Pino
Date:
Wed May 29 11:19:01 2002
used to describe $\int fv$

Definition at line 1151 of file VariationalOperatorExpression.hpp.

Member Enumeration Documentation

enum VariationalLinearOperatorExpression::OperatorType [inherited]

Enumerator:
FV  $\int fv$
FdxGV  $ \int f\partial_{x_i} g v $
FdxV  $ \int f\partial_{x_i} v $
FgradGgradV  $ \int f\\nabla g\cdot\nabla v $

Definition at line 312 of file VariationalOperatorExpression.hpp.

00312                     {
00313     FV,                         
00314     FdxGV,                      
00315     FdxV,                       
00316     FgradGgradV                 
00317   };

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

VariationalFVExpression::VariationalFVExpression ( ReferenceCounting< FunctionExpression >  f,
const std::string &  testFunctionName,
const VariationalOperator::Property &  testFunctionProperty,
ReferenceCounting< BoundaryExpression >  border = 0 
) [inline]

Constructor

Parameters:
f $ f$, the second member
testFunctionName a test function
testFunctionProperty a test function property
border the border where it is computed

Definition at line 1211 of file VariationalOperatorExpression.hpp.

01215     : VariationalLinearOperatorExpression(VariationalLinearOperatorExpression::FV,
01216                                           border, testFunctionName, testFunctionProperty),
01217       __f(f)
01218   {
01219     ;
01220   }

VariationalFVExpression::VariationalFVExpression ( const VariationalFVExpression &  V  )  [inline]

Copy Constructor

Parameters:
V 

Definition at line 1228 of file VariationalOperatorExpression.hpp.

01229     : VariationalLinearOperatorExpression(V),
01230       __f(V.__f)
01231   {
01232     ;
01233   }

VariationalFVExpression::~VariationalFVExpression (  )  [inline]

Destructor

Definition at line 1240 of file VariationalOperatorExpression.hpp.

01241   {
01242     ;
01243   }

Member Function Documentation

void VariationalFVExpression::__executeRemaining (  )  [inline, private, virtual]

VariationalLinearOperatorExpression::__executeRemaining() overloading

Implements VariationalLinearOperatorExpression.

Definition at line 1161 of file VariationalOperatorExpression.hpp.

01162   {
01163     (*__f).execute();
01164   }

bool VariationalFVExpression::__hasBoundaryExpression (  )  const [inline, private, virtual]

Implements VariationalLinearOperatorExpression.

Definition at line 1167 of file VariationalOperatorExpression.hpp.

01168   {
01169     return (*__f).hasBoundaryExpression();
01170   }

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

put function overloading

Parameters:
os the input (modified) stream
Returns:
os

Implements Expression.

Definition at line 1179 of file VariationalOperatorExpression.hpp.

References __f, VariationalLinearOperatorExpression::__testFunctionName, VariationalLinearOperatorExpression::__testTypeBeginWrite(), and VariationalLinearOperatorExpression::__testTypeEndWrite().

01180   {
01181     os << *__f
01182        << '*'
01183        << this->__testTypeBeginWrite()
01184        << __testFunctionName
01185        << this->__testTypeEndWrite();
01186     return os;
01187   }

Here is the call graph for this function:

ReferenceCounting<FunctionExpression> VariationalFVExpression::f (  )  [inline]

Returns the $ f$ function

Returns:
__f

Definition at line 1197 of file VariationalOperatorExpression.hpp.

References __f.

Referenced by VariationalProblemExpression::__internalSetLinear(), and VariationalProblemExpression::__internalSetLinearBC().

01198   {
01199     return __f;
01200   }

std::string VariationalLinearOperatorExpression::__propertyBeginWrite ( const VariationalOperator::Property &  property  )  const [inline, protected, inherited]

Definition at line 338 of file VariationalOperatorExpression.hpp.

References VariationalOperator::jump, and VariationalOperator::mean.

Referenced by VariationalLinearOperatorExpression::__testTypeBeginWrite().

00339   {
00340     switch(property) {
00341     case VariationalOperator::mean: {
00342       return "{";
00343       break;
00344     }
00345     case VariationalOperator::jump: {
00346       return "[";
00347       break;
00348     }
00349     default: {
00350       return "";
00351     }
00352     }
00353   }

std::string VariationalLinearOperatorExpression::__propertyEndWrite ( const VariationalOperator::Property &  property  )  const [inline, protected, inherited]

Definition at line 355 of file VariationalOperatorExpression.hpp.

References VariationalOperator::jump, and VariationalOperator::mean.

Referenced by VariationalLinearOperatorExpression::__testTypeEndWrite().

00356   {
00357     switch(property) {
00358     case VariationalOperator::mean: {
00359       return "}";
00360       break;
00361     }
00362     case VariationalOperator::jump: {
00363       return "]";
00364       break;
00365     }
00366     default: {
00367       return "";
00368     }
00369     }
00370   }

std::string VariationalLinearOperatorExpression::__testTypeBeginWrite (  )  const [inline, protected, inherited]

Definition at line 372 of file VariationalOperatorExpression.hpp.

References VariationalLinearOperatorExpression::__propertyBeginWrite(), and VariationalLinearOperatorExpression::__testFunctionProperty.

Referenced by VariationalFgradGgradVExpression::put(), VariationalFdxVExpression::put(), VariationalFdxGVExpression::put(), and put().

00373   {
00374     return __propertyBeginWrite(__testFunctionProperty);
00375   }

Here is the call graph for this function:

std::string VariationalLinearOperatorExpression::__testTypeEndWrite (  )  const [inline, protected, inherited]

Definition at line 377 of file VariationalOperatorExpression.hpp.

References VariationalLinearOperatorExpression::__propertyEndWrite(), and VariationalLinearOperatorExpression::__testFunctionProperty.

Referenced by VariationalFgradGgradVExpression::put(), VariationalFdxVExpression::put(), VariationalFdxGVExpression::put(), and put().

00378   {
00379     return __propertyEndWrite(__testFunctionProperty);
00380   }

Here is the call graph for this function:

char VariationalLinearOperatorExpression::__directionName ( const size_t &  i  )  const [inline, protected, inherited]

Definition at line 384 of file VariationalOperatorExpression.hpp.

References ErrorHandler::unexpected.

Referenced by VariationalFdxVExpression::put(), and VariationalFdxGVExpression::put().

00385   {
00386     switch(i) {
00387     case 0: return 'x';
00388     case 1: return 'y';
00389     case 2: return 'z';
00390     default: {
00391       throw ErrorHandler(__FILE__,__LINE__,": unknown direction",
00392                          ErrorHandler::unexpected);
00393       return '0';
00394     }
00395     }
00396   }

ReferenceCounting<BoundaryExpression> VariationalLinearOperatorExpression::border (  )  const [inline, inherited]

Returns the border Expression

Returns:
__border

Definition at line 410 of file VariationalOperatorExpression.hpp.

References VariationalLinearOperatorExpression::__border.

Referenced by VariationalProblemExpression::__internalSetLinearBC().

00411   {
00412     return __border;
00413   }

void VariationalLinearOperatorExpression::execute (  )  [inline, virtual, inherited]

Expression::execute() overloading

Implements Expression.

Definition at line 419 of file VariationalOperatorExpression.hpp.

References VariationalLinearOperatorExpression::__border, VariationalLinearOperatorExpression::__checkNoBoundaryExpression(), and VariationalLinearOperatorExpression::__executeRemaining().

Referenced by VariationalProblemExpression::__internalSetLinear().

00420   {
00421     if(__border != 0) {
00422       (*__border).execute();
00423     }
00424     __executeRemaining();
00425     if(__border == 0) {
00426       __checkNoBoundaryExpression();
00427     }
00428 
00429   }

Here is the call graph for this function:

OperatorType VariationalLinearOperatorExpression::operatorType (  )  [inline, inherited]

Access to the operator type

Returns:
__operatorType

Definition at line 437 of file VariationalOperatorExpression.hpp.

References VariationalLinearOperatorExpression::__operatorType.

00438   {
00439     return __operatorType;
00440   }

const std::string& VariationalLinearOperatorExpression::testFunctionName (  )  const [inline, inherited]

Access to the test function

Returns:
__testFunctionName

Definition at line 448 of file VariationalOperatorExpression.hpp.

References VariationalLinearOperatorExpression::__testFunctionName.

Referenced by VariationalProblemExpression::__internalSetLinear(), and VariationalProblemExpression::__internalSetLinearBC().

00449   {
00450     return __testFunctionName;
00451   }

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

ReferenceCounting<FunctionExpression> VariationalFVExpression::__f [private]

$ f$

Definition at line 1155 of file VariationalOperatorExpression.hpp.

Referenced by f(), and put().

const std::string VariationalLinearOperatorExpression::__testFunctionName [protected, inherited]

test function name

Definition at line 399 of file VariationalOperatorExpression.hpp.

Referenced by VariationalFgradGgradVExpression::put(), VariationalFdxVExpression::put(), VariationalFdxGVExpression::put(), put(), and VariationalLinearOperatorExpression::testFunctionName().

const VariationalOperator::Property VariationalLinearOperatorExpression::__testFunctionProperty [protected, inherited]

test function property

Definition at line 402 of file VariationalOperatorExpression.hpp.

Referenced by VariationalLinearOperatorExpression::__testTypeBeginWrite(), and VariationalLinearOperatorExpression::__testTypeEndWrite().

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