dune-fem 2.8.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
Dune::Fem::ScaledLocalOperator< A, ScalarType > Class Template Reference

#include <dune/fem/operator/common/localoperator.hh>

Inheritance diagram for Dune::Fem::ScaledLocalOperator< A, ScalarType >:
Inheritance graph

Public Member Functions

 ScaledLocalOperator (A &a, const ScalarType scalar, bool printMsg=false)
 Constructor for combinations with factors.
 
 ~ScaledLocalOperator ()
 
void scaleIt (const ScalarType &scalar)
 
template<class FirstParamType , class SecondParamType >
void prepareGlobal (const FirstParamType &pa, SecondParamType &pb)
 prepareGlobal is called before the grid walktrough
 
void finalizeGlobal ()
 finalizeGlobal is called after the grid walktrough
 
template<class EntityType >
void prepareLocal (EntityType &en)
 
template<class EntityType >
void finalizeLocal (EntityType &en)
 
template<class EntityType >
void prepareLocal (EntityType &en1, EntityType &en2)
 
template<class EntityType >
void finalizeLocal (EntityType &en1, EntityType &en2)
 
template<class EntityType >
void applyLocal (EntityType &en)
 
template<class EntityType >
void applyLocal (EntityType &en1, EntityType &en2)
 
template<class DiscrOpType >
void saveObjPointer (DiscrOpType *discrOp)
 Store new generated DiscreteOperator Pointer.
 
template<class DiscrOpType , class LocalOpType >
void saveObjPointer (DiscrOpType *discrOp, LocalOpType *lop)
 

Protected Attributes

A & _a
 reference to local operator A
 
const ScalarType scalar_
 scale factor for operator _a
 
ScalarType tmpScalar_
 
bool printMSG_
 

Detailed Description

template<class A, class ScalarType>
class Dune::Fem::ScaledLocalOperator< A, ScalarType >

ScaledLocalOperator which is a LocalOperator multipied by a scalar

Constructor & Destructor Documentation

◆ ScaledLocalOperator()

template<class A , class ScalarType >
Dune::Fem::ScaledLocalOperator< A, ScalarType >::ScaledLocalOperator ( A &  a,
const ScalarType  scalar,
bool  printMsg = false 
)
inline

Constructor for combinations with factors.

◆ ~ScaledLocalOperator()

template<class A , class ScalarType >
Dune::Fem::ScaledLocalOperator< A, ScalarType >::~ScaledLocalOperator ( )
inline

Member Function Documentation

◆ applyLocal() [1/2]

template<class A , class ScalarType >
template<class EntityType >
void Dune::Fem::ScaledLocalOperator< A, ScalarType >::applyLocal ( EntityType &  en)
inline

applyLocal defines the action one might do on a given or on two given entities. Up to now only max two entities may be parameter but this can be advanced. There is also an applyLocal method with no entity which means that also operators which dont need a grid walktrough can be combined.

◆ applyLocal() [2/2]

template<class A , class ScalarType >
template<class EntityType >
void Dune::Fem::ScaledLocalOperator< A, ScalarType >::applyLocal ( EntityType &  en1,
EntityType &  en2 
)
inline

◆ finalizeGlobal()

template<class A , class ScalarType >
void Dune::Fem::ScaledLocalOperator< A, ScalarType >::finalizeGlobal
inline

finalizeGlobal is called after the grid walktrough

◆ finalizeLocal() [1/2]

template<class A , class ScalarType >
template<class EntityType >
void Dune::Fem::ScaledLocalOperator< A, ScalarType >::finalizeLocal ( EntityType &  en)
inline
Todo:
Please doc me!

◆ finalizeLocal() [2/2]

template<class A , class ScalarType >
template<class EntityType >
void Dune::Fem::ScaledLocalOperator< A, ScalarType >::finalizeLocal ( EntityType &  en1,
EntityType &  en2 
)
inline
Todo:
Please doc me!

◆ prepareGlobal()

template<class A , class ScalarType >
template<class FirstParamType , class SecondParamType >
void Dune::Fem::ScaledLocalOperator< A, ScalarType >::prepareGlobal ( const FirstParamType &  pa,
SecondParamType &  pb 
)
inline

prepareGlobal is called before the grid walktrough

the parameters of prepareGlobal and finalizeGlobal are set outside via a setParameter method or something

◆ prepareLocal() [1/2]

template<class A , class ScalarType >
template<class EntityType >
void Dune::Fem::ScaledLocalOperator< A, ScalarType >::prepareLocal ( EntityType &  en)
inline

prepareLocal is called before applyLocal is called, it has different length of parameter list, which are always entities. For example one might give no parameters to prepareLocal or father and son element, depends on grid walktrough outside

◆ prepareLocal() [2/2]

template<class A , class ScalarType >
template<class EntityType >
void Dune::Fem::ScaledLocalOperator< A, ScalarType >::prepareLocal ( EntityType &  en1,
EntityType &  en2 
)
inline

◆ saveObjPointer() [1/2]

template<class DiscrOpType >
void Dune::Fem::ObjPointerStorage::saveObjPointer ( DiscrOpType *  discrOp)
inlineinherited

Store new generated DiscreteOperator Pointer.

◆ saveObjPointer() [2/2]

template<class DiscrOpType , class LocalOpType >
void Dune::Fem::ObjPointerStorage::saveObjPointer ( DiscrOpType *  discrOp,
LocalOpType *  lop 
)
inlineinherited

Store new generated DiscreteOperator Pointer and the LocalOperator pointer

◆ scaleIt()

template<class A , class ScalarType >
void Dune::Fem::ScaledLocalOperator< A, ScalarType >::scaleIt ( const ScalarType &  scalar)
inline

Member Data Documentation

◆ _a

template<class A , class ScalarType >
A& Dune::Fem::ScaledLocalOperator< A, ScalarType >::_a
protected

reference to local operator A

◆ printMSG_

template<class A , class ScalarType >
bool Dune::Fem::ScaledLocalOperator< A, ScalarType >::printMSG_
protected

◆ scalar_

template<class A , class ScalarType >
const ScalarType Dune::Fem::ScaledLocalOperator< A, ScalarType >::scalar_
protected

scale factor for operator _a

◆ tmpScalar_

template<class A , class ScalarType >
ScalarType Dune::Fem::ScaledLocalOperator< A, ScalarType >::tmpScalar_
protected

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