FEMFunctionBase Class Reference

#include <FEMFunctionBase.hpp>

Inheritance diagram for FEMFunctionBase:

Inheritance graph
[legend]
Collaboration diagram for FEMFunctionBase:

Collaboration graph
[legend]

List of all members.

Public Types

enum  Type {
  cfunction, constant, convection, dgfunction,
  femfunction, linearBasis, spectral, unaryMinus,
  modulo, sum, difference, product,
  division, power, min, max,
  gt, ge, lt, le,
  ne, eq, and_, or_,
  xor_, not_, derivate, integrate,
  normal, domainCharacteristic, meshCharacteristic, objectCharacteristic,
  composed, references, FEM0, undefined
}

Public Member Functions

void setOutsideValue (const real_t &value)
const real_t & outsideValue () const
bool canBeSimplified () const
bool hasSameType (const FEMFunctionBase &f) const
ConstReferenceCounting< Mesh > baseMesh () const
const
ScalarDiscretizationTypeBase::Type & 		discretizationType () const
const Vector< real_t > & values () const
real_t & operator[] (const size_t &i)
const real_t & operator[] (const size_t &i) const
void operator= (const Vector< real_t > &values)
virtual void operator= (const ScalarFunctionBase &f)=0
virtual TinyVector< 3, real_t > gradient (const TinyVector< 3, real_t > &x) const =0
 FEMFunctionBase (const Mesh *mesh, const ScalarDiscretizationTypeFEM &discretizationType)
virtual ~FEMFunctionBase ()
void setName (const std::string &name)
const std::string & name () const
const Type & type () const
real_t operator() (const real_t &x, const real_t &y, const real_t &z) const
virtual real_t operator() (const TinyVector< 3, real_t > &X) const =0
virtual real_t dx (const TinyVector< 3, real_t > &x) const
virtual real_t dy (const TinyVector< 3, real_t > &x) const
virtual real_t dz (const TinyVector< 3, real_t > &x) const

Protected Member Functions

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

Protected Attributes

ConstReferenceCounting< Mesh > __baseMesh
ConstReferenceCounting
< ScalarDegreeOfFreedomPositionsSet > 		__dofPositionsSet
Vector< real_t > __values
const ScalarDiscretizationTypeFEM __discretizationType
real_t __outsideValue
const Type __type
std::string __name

Friends

std::ostream & operator<< (std::ostream &os, const ScalarFunctionBase &scalarFunction)

Detailed Description

Definition at line 41 of file FEMFunctionBase.hpp.

Member Enumeration Documentation

enum ScalarFunctionBase::Type [inherited]

Enumerator:
cfunction 
constant 
convection 
dgfunction 
femfunction 
linearBasis 
spectral 
unaryMinus 
modulo 
sum 
difference 
product 
division 
power 
min 
max 
gt 
ge 
lt 
le 
ne 
eq 
and_ 
or_ 
xor_ 
not_ 
derivate 
integrate 
normal 
domainCharacteristic 
meshCharacteristic 
objectCharacteristic 
composed 
references 
FEM0 
undefined 

Definition at line 40 of file ScalarFunctionBase.hpp.

00040             {
00041     cfunction,
00042     constant,
00043     convection,
00044     dgfunction,
00045     femfunction,
00046     linearBasis,
00047     spectral,
00048     unaryMinus,
00049 
00050     modulo,
00051     sum,
00052     difference,
00053     product,
00054     division,
00055     power,
00056 
00057     min,
00058     max,
00059 
00060     gt,
00061     ge,
00062     lt,
00063     le,
00064     ne,
00065     eq,
00066     and_,
00067     or_,
00068     xor_,
00069 
00070     not_,
00071 
00072     derivate,
00073     integrate,
00074 
00075     normal,
00076 
00077     domainCharacteristic,
00078     meshCharacteristic,
00079     objectCharacteristic,
00080 
00081     composed,
00082     references,
00083 
00084     FEM0,
00085 
00086     undefined
00087   };

Constructor & Destructor Documentation

FEMFunctionBase::FEMFunctionBase ( const Mesh *  mesh,
const ScalarDiscretizationTypeFEM &  discretizationType 
) [inline]

Constructor

Parameters:
mesh the mesh supporting the function
discretizationType the type of finite element discretization

Definition at line 213 of file FEMFunctionBase.hpp.

00215     : ScalarFunctionBase(ScalarFunctionBase::femfunction),
00216       __baseMesh(mesh),
00217       __dofPositionsSet(DegreeOfFreedomSetManager::instance().getDOFPositionsSet(*mesh,discretizationType)),
00218       __values(__dofPositionsSet->number()),
00219       __discretizationType(discretizationType),
00220       __outsideValue(0)
00221   {
00222     ;
00223   }

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

Destructor

Definition at line 229 of file FEMFunctionBase.hpp.

References __dofPositionsSet, StaticBase< DegreeOfFreedomSetManager >::instance(), and DegreeOfFreedomSetManager::unsubscribe().

00230   {
00231     DegreeOfFreedomSetManager::instance().unsubscribe(__dofPositionsSet);
00232   }

Here is the call graph for this function:

Member Function Documentation

std::ostream& FEMFunctionBase::__put ( std::ostream &  os  )  const [inline, protected, virtual]

output of the FEMFunction

Parameters:
os output stream
Returns:
os

Implements ScalarFunctionBase.

Definition at line 64 of file FEMFunctionBase.hpp.

References __discretizationType, and ScalarDiscretizationTypeBase::name().

00065   {
00066     os << "{fem-" << ScalarDiscretizationTypeBase::name(__discretizationType) << '}';
00067     return os;
00068   }

Here is the call graph for this function:

void FEMFunctionBase::setOutsideValue ( const real_t &  value  )  [inline]

set outside value

Parameters:
value outside value

Definition at line 87 of file FEMFunctionBase.hpp.

References __outsideValue.

Referenced by FEMFunctionBuilder::build().

00088   {
00089     __outsideValue = value;
00090   }

const real_t& FEMFunctionBase::outsideValue (  )  const [inline]

Access to the outside value

Returns:
__outsidValue

Definition at line 97 of file FEMFunctionBase.hpp.

References __outsideValue.

Referenced by ScalarFunctionBuilder::Simplifier::__getOperatorF1F2SimplifiedFunction(), and ScalarFunctionBuilder::setUnaryMinus().

00098   {
00099     return __outsideValue;
00100   }

bool FEMFunctionBase::canBeSimplified (  )  const [inline, virtual]

Checks if the function can be simplified

Returns:
true

Implements ScalarFunctionBase.

Definition at line 107 of file FEMFunctionBase.hpp.

00108   {
00109     return true;
00110   }

bool FEMFunctionBase::hasSameType ( const FEMFunctionBase &  f  )  const [inline]

Check if a finite element function is of the same type

Parameters:
f given function
Returns:
true if discretization type and mesh are the same

Definition at line 119 of file FEMFunctionBase.hpp.

References __baseMesh, __discretizationType, and ScalarDiscretizationTypeBase::type().

Referenced by ScalarFunctionBuilder::Simplifier::__getOperatorSimplifiedFunction().

00120   {
00121     return ((__discretizationType.type() == f.__discretizationType.type())
00122             and (__baseMesh == f.__baseMesh));
00123   }

Here is the call graph for this function:

ConstReferenceCounting<Mesh> FEMFunctionBase::baseMesh (  )  const [inline]

Access to the mesh through its base class

Returns:
__baseMesh

Definition at line 130 of file FEMFunctionBase.hpp.

References __baseMesh.

Referenced by WriterVTK::__fillCrossedComponent(), WriterMedit::__fillCrossedComponent(), ScalarFunctionBuilder::Simplifier::__getOperatorF1F2SimplifiedFunction(), WriterVTK::__proceed(), WriterMedit::__proceedData(), WriterRaw::__saveScalarFunction(), FEMDiscretization< Structured3DMesh, TypeOfDiscretization >::assembleSecondMember(), InstructionAffectation< FunctionExpression, FunctionVariable >::execute(), FEMFunction< MeshType, FiniteElementTraits >::operator=(), and ScalarFunctionBuilder::setUnaryMinus().

00131   {
00132     return __baseMesh;
00133   }

const ScalarDiscretizationTypeBase::Type& FEMFunctionBase::discretizationType (  )  const [inline]

The type of the finite elememt function

Returns:
__discretizationType

Definition at line 140 of file FEMFunctionBase.hpp.

References __discretizationType, and ScalarDiscretizationTypeBase::type().

Referenced by WriterVTK::__fillCrossedComponent(), WriterMedit::__fillCrossedComponent(), ScalarFunctionBuilder::Simplifier::__getOperatorF1F2SimplifiedFunction(), WriterVTK::__proceed(), WriterMedit::__proceedData(), InstructionAffectation< FunctionExpression, FunctionVariable >::execute(), FEMFunction< MeshType, FiniteElementTraits >::operator=(), and ScalarFunctionBuilder::setUnaryMinus().

00141   {
00142     return __discretizationType.type();
00143   }

Here is the call graph for this function:

const Vector<real_t>& FEMFunctionBase::values (  )  const [inline]

Read-only access to the set of values

Returns:
__values

Definition at line 150 of file FEMFunctionBase.hpp.

References __values.

Referenced by WriterVTK::__fillCrossedComponent(), WriterMedit::__fillCrossedComponent(), ScalarFunctionBuilder::Simplifier::__getOperatorF1F2SimplifiedFunction(), WriterMedit::__proceedData(), and ScalarFunctionBuilder::setUnaryMinus().

00151   {
00152     return __values;
00153   }

real_t& FEMFunctionBase::operator[] ( const size_t &  i  )  [inline]

access to the value at the ith degree of freedom

Parameters:
i number of the degree of freedom
Returns:
__values[i]

Definition at line 162 of file FEMFunctionBase.hpp.

References __values.

00163   {
00164     return __values[i];
00165   }

const real_t& FEMFunctionBase::operator[] ( const size_t &  i  )  const [inline]

Read only Access to the value at the ith degree of freedom

Parameters:
i number of the degree of freedom
Returns:
__values[i]

Definition at line 174 of file FEMFunctionBase.hpp.

References __values.

00175   {
00176     return __values[i];
00177   }

void FEMFunctionBase::operator= ( const Vector< real_t > &  values  )  [inline]

Affects the vector values

Parameters:
values new values

Definition at line 184 of file FEMFunctionBase.hpp.

References __values, ASSERT, and Vector< T >::size().

00185   {
00186     ASSERT (values.size() == __values.size());
00187     __values = values;
00188   }

Here is the call graph for this function:

virtual void FEMFunctionBase::operator= ( const ScalarFunctionBase &  f  )  [pure virtual]

Affects a function to a FEMFunction

Parameters:
f original function

Implemented in FEMFunction< MeshType, FiniteElementTraits >.

virtual TinyVector<3,real_t> FEMFunctionBase::gradient ( const TinyVector< 3, real_t > &  x  )  const [pure virtual]

Returns the gradient of a FEMFunction at position x

Parameters:
x position of evaluation
Returns:
$ \nabla f (x) $

Implemented in FEMFunction< MeshType, FiniteElementTraits >.

Referenced by FEMDiscretization< Structured3DMesh, TypeOfDiscretization >::assembleSecondMember().

void ScalarFunctionBase::setName ( const std::string &  name  )  [inline, inherited]

Sets the name of the function

Parameters:
name name to give to this function

Definition at line 109 of file ScalarFunctionBase.hpp.

References ScalarFunctionBase::__name.

Referenced by FunctionExpressionVariable::execute().

00110   {
00111     __name = name;
00112   }

const std::string& ScalarFunctionBase::name (  )  const [inline, inherited]

Gets the name of the function

Returns:
__name

Definition at line 119 of file ScalarFunctionBase.hpp.

References ScalarFunctionBase::__name.

00120   {
00121     return __name;
00122   }

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

Read-only access to the type of the function

Returns:
__type

Definition at line 129 of file ScalarFunctionBase.hpp.

References ScalarFunctionBase::__type.

Referenced by WriterVTK::__fillCrossedComponent(), WriterMedit::__fillCrossedComponent(), ScalarFunctionBuilder::Simplifier::__getOperatorF1SimplifiedFunction(), ScalarFunctionBuilder::Simplifier::__getOperatorSimplifiedFunction(), WriterVTK::__proceed(), WriterMedit::__proceedData(), WriterRaw::__saveScalarFunction(), FEMDiscretization< Structured3DMesh, TypeOfDiscretization >::assembleSecondMember(), InstructionAffectation< FunctionExpression, FunctionVariable >::execute(), FEMFunction< MeshType, FiniteElementTraits >::operator=(), and DGFunction< MeshType, FiniteElementTraits >::operator=().

00130   {
00131     return __type;
00132   }

real_t ScalarFunctionBase::operator() ( const real_t &  x,
const real_t &  y,
const real_t &  z 
) const [inline, inherited]

Evaluates the function at point $ (x,y,z) $

Parameters:
x $ x $
y $ y $
z $ z $
Returns:
$ f(x,y,z) $

Definition at line 162 of file ScalarFunctionBase.hpp.

00165   {
00166     return this->operator()(TinyVector<3, real_t>(x,y,z));    
00167   }

virtual real_t ScalarFunctionBase::operator() ( const TinyVector< 3, real_t > &  X  )  const [pure virtual, inherited]

Evaluates the gunction at point $ X $

Parameters:
X point of evaluation of the function
Returns:
$ f(X) $

Implemented in DGFunction< MeshType, FiniteElementTraits >, FEMFunction< MeshType, FiniteElementTraits >, ScalarFunctionAnd, ScalarFunctionCFunction, ScalarFunctionComposed, ScalarFunctionConstant, ScalarFunctionDerivative, ScalarFunctionDifference, ScalarFunctionDivision, ScalarFunctionDomainCharacteristic, ScalarFunctionEqual, ScalarFunctionGreaterEqual, ScalarFunctionGreaterThan, ScalarFunctionIntegrate, ScalarFunctionLinearBasis, ScalarFunctionLowerEqual, ScalarFunctionLowerThan, ScalarFunctionMax, ScalarFunctionMeshCharacteristic, ScalarFunctionMeshElementsReferences, ScalarFunctionMin, ScalarFunctionModulo, ScalarFunctionNormal, ScalarFunctionNot, ScalarFunctionNotEqual, ScalarFunctionObjectCharacteristic, ScalarFunctionOr, ScalarFunctionPower, ScalarFunctionProduct, ScalarFunctionSum, ScalarFunctionUnaryMinus, ScalarFunctionXor, and SpectralFunction.

virtual real_t ScalarFunctionBase::dx ( const TinyVector< 3, real_t > &  x  )  const [inline, virtual, inherited]

Evaluates first derivative of the function

Parameters:
x position of evaluation
Returns:
$ \partial_x f $ at position $ x $

Definition at line 185 of file ScalarFunctionBase.hpp.

References ErrorHandler::normal.

00186   {
00187     std::stringstream errorMsg;
00188 
00189     errorMsg << "cannot compute derivative of non discrete functions :-(\n";
00190     errorMsg << "the function " << (*this) << " is not of that kind"
00191              << std::ends;
00192 
00193     throw ErrorHandler(__FILE__,__LINE__,
00194                        errorMsg.str(),
00195                        ErrorHandler::normal);
00196     return 0;
00197   }

virtual real_t ScalarFunctionBase::dy ( const TinyVector< 3, real_t > &  x  )  const [inline, virtual, inherited]

Evaluates second derivative of the function

Parameters:
x position of evaluation
Returns:
$ \partial_y f $ at position $ x $

Definition at line 206 of file ScalarFunctionBase.hpp.

References ErrorHandler::normal.

00207   {
00208     std::stringstream errorMsg;
00209 
00210     errorMsg << "cannot compute derivative of non discrete functions :-(\n";
00211     errorMsg << "the function " << (*this) << " is not of that kind"
00212              << std::ends;
00213 
00214     throw ErrorHandler(__FILE__,__LINE__,
00215                        errorMsg.str(),
00216                        ErrorHandler::normal);
00217     return 0;
00218   }

virtual real_t ScalarFunctionBase::dz ( const TinyVector< 3, real_t > &  x  )  const [inline, virtual, inherited]

Evaluates third derivative of the function

Parameters:
x position of evaluation
Returns:
$ \partial_z f $ at position $ x $

Definition at line 227 of file ScalarFunctionBase.hpp.

References ErrorHandler::normal.

00228   {
00229     std::stringstream errorMsg;
00230 
00231     errorMsg << "cannot compute derivative of non discrete functions :-(\n";
00232     errorMsg << "the function " << (*this) << " is not of that kind"
00233              << std::ends;
00234 
00235     throw ErrorHandler(__FILE__,__LINE__,
00236                        errorMsg.str(),
00237                        ErrorHandler::normal);
00238     return 0;
00239   }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
const ScalarFunctionBase &  scalarFunction 
) [friend, inherited]

Writes the function scalarFunction to the stream os

Parameters:
os the output stream
scalarFunction the function to write
Returns:
os

Definition at line 142 of file ScalarFunctionBase.hpp.

00144   {
00145     if (scalarFunction.__name.size()>0) {
00146       os << scalarFunction.__name;
00147       return os;
00148     } else {
00149       return scalarFunction.__put(os);
00150     }
00151   }

Member Data Documentation

ConstReferenceCounting<Mesh> FEMFunctionBase::__baseMesh [protected]

reference to the mesh through the Mesh (basis) class

Definition at line 46 of file FEMFunctionBase.hpp.

Referenced by baseMesh(), and hasSameType().

ConstReferenceCounting<ScalarDegreeOfFreedomPositionsSet> FEMFunctionBase::__dofPositionsSet [protected]

degree of freedom position set

Definition at line 50 of file FEMFunctionBase.hpp.

Referenced by FEMFunction< MeshType, FiniteElementTraits >::operator=(), and ~FEMFunctionBase().

Vector<real_t> FEMFunctionBase::__values [protected]

vector of values

Definition at line 52 of file FEMFunctionBase.hpp.

Referenced by FEMFunction< MeshType, FiniteElementTraits >::FEMFunction(), FEMFunction< MeshType, FiniteElementTraits >::gradient(), FEMFunction< MeshType, FiniteElementTraits >::operator()(), operator=(), FEMFunction< MeshType, FiniteElementTraits >::operator=(), operator[](), and values().

const ScalarDiscretizationTypeFEM FEMFunctionBase::__discretizationType [protected]

type of discretization

Definition at line 55 of file FEMFunctionBase.hpp.

Referenced by __put(), discretizationType(), and hasSameType().

real_t FEMFunctionBase::__outsideValue [protected]

this value is returned when function is evaluated outside the mesh.

Note:
It is required to allow expression like $ f+a $ (where $ f $ is a fem-function and $ a $ a constant) to be simplifed (FEM functions are considered to be 0 outside the mesh by convention).

Definition at line 79 of file FEMFunctionBase.hpp.

Referenced by FEMFunction< MeshType, FiniteElementTraits >::operator()(), FEMFunction< MeshType, FiniteElementTraits >::operator=(), outsideValue(), and setOutsideValue().

const Type ScalarFunctionBase::__type [protected, inherited]

type of the function

Definition at line 90 of file ScalarFunctionBase.hpp.

Referenced by ScalarFunctionBase::type().

std::string ScalarFunctionBase::__name [protected, inherited]

name of the function

Definition at line 92 of file ScalarFunctionBase.hpp.

Referenced by ScalarFunctionBase::name(), and ScalarFunctionBase::setName().

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