dune-fem 2.8.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Dune::Fem::RestrictProlongDefault< DiscreteFunction > Class Template Reference

This is a wrapper for the default implemented restriction/prolongation operator, which only takes a discrete function template. More...

#include <dune/fem/space/common/restrictprolonginterface.hh>

Inheritance diagram for Dune::Fem::RestrictProlongDefault< DiscreteFunction >:
Inheritance graph

Public Types

typedef DiscreteFunction DiscreteFunctionType
 
typedef BaseType::DomainFieldType DomainFieldType
 
typedef DiscreteFunctionType::DiscreteFunctionSpaceType DiscreteFunctionSpaceType
 
typedef ConstLocalFunction< DiscreteFunctionTypeConstLocalFunctionType
 
typedef MutableLocalFunction< DiscreteFunctionTypeMutableLocalFunctionType
 
typedef DiscreteFunctionType::GridPartType GridPartType
 
typedef DefaultLocalRestrictProlong< DiscreteFunctionSpaceTypeLocalRestrictProlongType
 
typedef Traits::RestProlImp RestProlImp
 type of restrict-prolong operator implementation
 

Public Member Functions

 RestrictProlongDefault (const RestrictProlongDefault &other)
 
 RestrictProlongDefault (DiscreteFunctionType &discreteFunction)
 
void setFatherChildWeight (const DomainFieldType &weight) const
 explicit set volume ratio of son and father
 
template<class Entity >
void restrictLocal (const Entity &father, const Entity &son, bool initialize) const
 restrict data to father
 
template<class Entity , class LocalGeometry >
void restrictLocal (const Entity &father, const Entity &son, const LocalGeometry &geometryInFather, bool initialize) const
 restrict data to father
 
template<class Entity >
void restrictFinalize (const Entity &father) const
 finalize restriction on father
 
template<class Entity >
void prolongLocal (const Entity &father, const Entity &son, bool initialize) const
 prolong data to children
 
template<class Entity , class LocalGeometry >
void prolongLocal (const Entity &father, const Entity &son, const LocalGeometry &geometryInFather, bool initialize) const
 prolong data to children
 
template<class Communicator , class Operation >
void addToList (Communicator &comm, const Operation &op)
 add discrete function to communicator with given unpack operation
 
template<class Communicator >
void addToList (Communicator &comm)
 add discrete function to communicator
 
template<class Communicator >
void removeFromList (Communicator &comm)
 remove discrete function from communicator
 
template<class LoadBalancer >
void addToLoadBalancer (LoadBalancer &lb)
 add discrete function to load balancer
 
void setFatherChildWeight (const DomainFieldType &weight) const
 explicit set volume ratio of son and father
 
void initialize ()
 
void finalize ()
 

Protected Member Functions

template<class IndexSet , class Entity >
bool entitiesAreCopies (const IndexSet &indexSet, const Entity &father, const Entity &son) const
 return true if father and son have the same index
 
template<class Entity >
DomainFieldType calcWeight (const Entity &father, const Entity &son) const
 calculates the weight, i.e. (volume son)/(volume father)
 
const RestProlImpasImp () const
 
RestProlImpasImp ()
 

Protected Attributes

DiscreteFunctionTypediscreteFunction_
 
ConstLocalFunctionType constLf_
 
MutableLocalFunctionType targetLf_
 
LocalRestrictProlongType localRP_
 

Detailed Description

template<class DiscreteFunction>
class Dune::Fem::RestrictProlongDefault< DiscreteFunction >

This is a wrapper for the default implemented restriction/prolongation operator, which only takes a discrete function template.

Member Typedef Documentation

◆ ConstLocalFunctionType

template<class DiscreteFunction >
typedef ConstLocalFunction< DiscreteFunctionType > Dune::Fem::RestrictProlongDefault< DiscreteFunction >::ConstLocalFunctionType

◆ DiscreteFunctionSpaceType

template<class DiscreteFunction >
typedef DiscreteFunctionType::DiscreteFunctionSpaceType Dune::Fem::RestrictProlongDefault< DiscreteFunction >::DiscreteFunctionSpaceType

◆ DiscreteFunctionType

template<class DiscreteFunction >
typedef DiscreteFunction Dune::Fem::RestrictProlongDefault< DiscreteFunction >::DiscreteFunctionType

◆ DomainFieldType

template<class DiscreteFunction >
typedef BaseType::DomainFieldType Dune::Fem::RestrictProlongDefault< DiscreteFunction >::DomainFieldType

◆ GridPartType

template<class DiscreteFunction >
typedef DiscreteFunctionType::GridPartType Dune::Fem::RestrictProlongDefault< DiscreteFunction >::GridPartType

◆ LocalRestrictProlongType

template<class DiscreteFunction >
typedef DefaultLocalRestrictProlong< DiscreteFunctionSpaceType > Dune::Fem::RestrictProlongDefault< DiscreteFunction >::LocalRestrictProlongType

◆ MutableLocalFunctionType

template<class DiscreteFunction >
typedef MutableLocalFunction< DiscreteFunctionType > Dune::Fem::RestrictProlongDefault< DiscreteFunction >::MutableLocalFunctionType

◆ RestProlImp

template<class Traits >
typedef Traits::RestProlImp Dune::Fem::RestrictProlongInterface< Traits >::RestProlImp
inherited

type of restrict-prolong operator implementation

Constructor & Destructor Documentation

◆ RestrictProlongDefault() [1/2]

template<class DiscreteFunction >
Dune::Fem::RestrictProlongDefault< DiscreteFunction >::RestrictProlongDefault ( const RestrictProlongDefault< DiscreteFunction > &  other)
inline

◆ RestrictProlongDefault() [2/2]

template<class DiscreteFunction >
Dune::Fem::RestrictProlongDefault< DiscreteFunction >::RestrictProlongDefault ( DiscreteFunctionType discreteFunction)
inlineexplicit

Member Function Documentation

◆ addToList() [1/2]

template<class DiscreteFunction >
template<class Communicator >
void Dune::Fem::RestrictProlongDefault< DiscreteFunction >::addToList ( Communicator &  comm)
inline

add discrete function to communicator

◆ addToList() [2/2]

template<class DiscreteFunction >
template<class Communicator , class Operation >
void Dune::Fem::RestrictProlongDefault< DiscreteFunction >::addToList ( Communicator &  comm,
const Operation &  op 
)
inline

add discrete function to communicator with given unpack operation

◆ addToLoadBalancer()

template<class DiscreteFunction >
template<class LoadBalancer >
void Dune::Fem::RestrictProlongDefault< DiscreteFunction >::addToLoadBalancer ( LoadBalancer lb)
inline

add discrete function to load balancer

◆ asImp() [1/2]

template<class Traits >
RestProlImp & Dune::Fem::RestrictProlongInterface< Traits >::asImp ( )
inlineprotectedinherited

◆ asImp() [2/2]

template<class Traits >
const RestProlImp & Dune::Fem::RestrictProlongInterface< Traits >::asImp ( ) const
inlineprotectedinherited

◆ calcWeight()

template<class Traits >
template<class Entity >
DomainFieldType Dune::Fem::RestrictProlongInterface< Traits >::calcWeight ( const Entity &  father,
const Entity &  son 
) const
inlineprotectedinherited

calculates the weight, i.e. (volume son)/(volume father)

Parameters
[in]fatherFather Entity
[in]sonSon Entity
Returns
proportion between fahter and son volume

◆ entitiesAreCopies()

template<class DiscreteFunction >
template<class IndexSet , class Entity >
bool Dune::Fem::RestrictProlongInterfaceDefault< Traits >::entitiesAreCopies ( const IndexSet indexSet,
const Entity &  father,
const Entity &  son 
) const
inlineprotected

return true if father and son have the same index

◆ finalize()

void Dune::Fem::RestrictProlongInterfaceDefault< RestrictProlongTraits< RestrictProlongDefault< DiscreteFunction >, DiscreteFunction::DomainFieldType > >::finalize ( )
inlineinherited

◆ initialize()

void Dune::Fem::RestrictProlongInterfaceDefault< RestrictProlongTraits< RestrictProlongDefault< DiscreteFunction >, DiscreteFunction::DomainFieldType > >::initialize ( )
inlineinherited

◆ prolongLocal() [1/2]

template<class DiscreteFunction >
template<class Entity >
void Dune::Fem::RestrictProlongDefault< DiscreteFunction >::prolongLocal ( const Entity &  father,
const Entity &  son,
bool  initialize 
) const
inline

prolong data to children

◆ prolongLocal() [2/2]

template<class DiscreteFunction >
template<class Entity , class LocalGeometry >
void Dune::Fem::RestrictProlongDefault< DiscreteFunction >::prolongLocal ( const Entity &  father,
const Entity &  son,
const LocalGeometry &  geometryInFather,
bool  initialize 
) const
inline

prolong data to children

◆ removeFromList()

template<class DiscreteFunction >
template<class Communicator >
void Dune::Fem::RestrictProlongDefault< DiscreteFunction >::removeFromList ( Communicator &  comm)
inline

remove discrete function from communicator

◆ restrictFinalize()

template<class DiscreteFunction >
template<class Entity >
void Dune::Fem::RestrictProlongDefault< DiscreteFunction >::restrictFinalize ( const Entity &  father) const
inline

finalize restriction on father

◆ restrictLocal() [1/2]

template<class DiscreteFunction >
template<class Entity >
void Dune::Fem::RestrictProlongDefault< DiscreteFunction >::restrictLocal ( const Entity &  father,
const Entity &  son,
bool  initialize 
) const
inline

restrict data to father

◆ restrictLocal() [2/2]

template<class DiscreteFunction >
template<class Entity , class LocalGeometry >
void Dune::Fem::RestrictProlongDefault< DiscreteFunction >::restrictLocal ( const Entity &  father,
const Entity &  son,
const LocalGeometry &  geometryInFather,
bool  initialize 
) const
inline

restrict data to father

◆ setFatherChildWeight() [1/2]

void Dune::Fem::RestrictProlongInterfaceDefault< RestrictProlongTraits< RestrictProlongDefault< DiscreteFunction >, DiscreteFunction::DomainFieldType > >::setFatherChildWeight ( const DomainFieldType weight) const
inlineinherited

◆ setFatherChildWeight() [2/2]

template<class DiscreteFunction >
void Dune::Fem::RestrictProlongDefault< DiscreteFunction >::setFatherChildWeight ( const DomainFieldType weight) const
inline

explicit set volume ratio of son and father

Parameters
[in]weightvolume of son / volume of father
Note
If this ratio is set, it is assume to be constant.

Member Data Documentation

◆ constLf_

template<class DiscreteFunction >
ConstLocalFunctionType Dune::Fem::RestrictProlongDefault< DiscreteFunction >::constLf_
mutableprotected

◆ discreteFunction_

template<class DiscreteFunction >
DiscreteFunctionType& Dune::Fem::RestrictProlongDefault< DiscreteFunction >::discreteFunction_
protected

◆ localRP_

template<class DiscreteFunction >
LocalRestrictProlongType Dune::Fem::RestrictProlongDefault< DiscreteFunction >::localRP_
mutableprotected

◆ targetLf_

template<class DiscreteFunction >
MutableLocalFunctionType Dune::Fem::RestrictProlongDefault< DiscreteFunction >::targetLf_
mutableprotected

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