dune-fem  2.4.1-rc
Public Types | Public Member Functions | Static Public Attributes | List of all members
Dune::Fem::StartPass< ArgumentImp, passIdImp, NonBlockingCommunication > Class Template Reference

End marker for a compile-time list of passes. More...

#include </local/tomalk/somewhere/tmp/dune-fem/dune/fem/pass/common/pass.hh>

Public Types

typedef std::tuple< std::integral_constant< int, passIdImp > > PassIds
 pass ids up to here (tuple of integral constants) More...
 
typedef ArgumentImp GlobalArgumentType
 The argument (and destination) type of the overall operator. More...
 
typedef std::tuple NextArgumentType
 End marker for tuple of return types of the passes. More...
 

Public Member Functions

 StartPass ()
 empty constructor More...
 
 StartPass (const StartPass &)
 copy constructor More...
 
void pass (const GlobalArgumentType &arg) const
 The pass method initialized the communication only. More...
 
void receiveCommunication (const GlobalArgumentType &arg) const
 receive data for previously initialized communication More...
 
void finalizeCommunication (const GlobalArgumentType &arg) const
 cleanup of overwritten data. i.e. ghost values if neccessary More...
 
void printTexInfo (std::ostream &out) const
 
NextArgumentType localArgument () const
 Returns the closure of the destination tuple. More...
 
void allocateLocalMemory ()
 No memory needs to be allocated. More...
 
void setTime (const double)
 StartPass does not need a time. More...
 
double timeStepEstimate () const
 return time step estimate More...
 

Static Public Attributes

static const int passNum = 0
 position in pass tree (0 for start pass) More...
 
static const int passId = passIdImp
 

Detailed Description

template<class ArgumentImp, int passIdImp, class NonBlockingCommunication = EmptyNonBlockingComm>
class Dune::Fem::StartPass< ArgumentImp, passIdImp, NonBlockingCommunication >

End marker for a compile-time list of passes.

Member Typedef Documentation

template<class ArgumentImp , int passIdImp, class NonBlockingCommunication = EmptyNonBlockingComm>
typedef ArgumentImp Dune::Fem::StartPass< ArgumentImp, passIdImp, NonBlockingCommunication >::GlobalArgumentType

The argument (and destination) type of the overall operator.

template<class ArgumentImp , int passIdImp, class NonBlockingCommunication = EmptyNonBlockingComm>
typedef std::tuple Dune::Fem::StartPass< ArgumentImp, passIdImp, NonBlockingCommunication >::NextArgumentType

End marker for tuple of return types of the passes.

template<class ArgumentImp , int passIdImp, class NonBlockingCommunication = EmptyNonBlockingComm>
typedef std::tuple< std::integral_constant< int, passIdImp > > Dune::Fem::StartPass< ArgumentImp, passIdImp, NonBlockingCommunication >::PassIds

pass ids up to here (tuple of integral constants)

Constructor & Destructor Documentation

template<class ArgumentImp , int passIdImp, class NonBlockingCommunication = EmptyNonBlockingComm>
Dune::Fem::StartPass< ArgumentImp, passIdImp, NonBlockingCommunication >::StartPass ( )
inline

empty constructor

template<class ArgumentImp , int passIdImp, class NonBlockingCommunication = EmptyNonBlockingComm>
Dune::Fem::StartPass< ArgumentImp, passIdImp, NonBlockingCommunication >::StartPass ( const StartPass< ArgumentImp, passIdImp, NonBlockingCommunication > &  )
inline

copy constructor

Member Function Documentation

template<class ArgumentImp , int passIdImp, class NonBlockingCommunication = EmptyNonBlockingComm>
void Dune::Fem::StartPass< ArgumentImp, passIdImp, NonBlockingCommunication >::allocateLocalMemory ( )
inline

No memory needs to be allocated.

template<class ArgumentImp , int passIdImp, class NonBlockingCommunication = EmptyNonBlockingComm>
void Dune::Fem::StartPass< ArgumentImp, passIdImp, NonBlockingCommunication >::finalizeCommunication ( const GlobalArgumentType arg) const
inline

cleanup of overwritten data. i.e. ghost values if neccessary

template<class ArgumentImp , int passIdImp, class NonBlockingCommunication = EmptyNonBlockingComm>
NextArgumentType Dune::Fem::StartPass< ArgumentImp, passIdImp, NonBlockingCommunication >::localArgument ( ) const
inline

Returns the closure of the destination tuple.

template<class ArgumentImp , int passIdImp, class NonBlockingCommunication = EmptyNonBlockingComm>
void Dune::Fem::StartPass< ArgumentImp, passIdImp, NonBlockingCommunication >::pass ( const GlobalArgumentType arg) const
inline

The pass method initialized the communication only.

template<class ArgumentImp , int passIdImp, class NonBlockingCommunication = EmptyNonBlockingComm>
void Dune::Fem::StartPass< ArgumentImp, passIdImp, NonBlockingCommunication >::printTexInfo ( std::ostream &  out) const
inline
template<class ArgumentImp , int passIdImp, class NonBlockingCommunication = EmptyNonBlockingComm>
void Dune::Fem::StartPass< ArgumentImp, passIdImp, NonBlockingCommunication >::receiveCommunication ( const GlobalArgumentType arg) const
inline

receive data for previously initialized communication

template<class ArgumentImp , int passIdImp, class NonBlockingCommunication = EmptyNonBlockingComm>
void Dune::Fem::StartPass< ArgumentImp, passIdImp, NonBlockingCommunication >::setTime ( const double  )
inline

StartPass does not need a time.

template<class ArgumentImp , int passIdImp, class NonBlockingCommunication = EmptyNonBlockingComm>
double Dune::Fem::StartPass< ArgumentImp, passIdImp, NonBlockingCommunication >::timeStepEstimate ( ) const
inline

return time step estimate

References Dune::Std::max().

Member Data Documentation

template<class ArgumentImp , int passIdImp, class NonBlockingCommunication = EmptyNonBlockingComm>
const int Dune::Fem::StartPass< ArgumentImp, passIdImp, NonBlockingCommunication >::passId = passIdImp
static
template<class ArgumentImp , int passIdImp, class NonBlockingCommunication = EmptyNonBlockingComm>
const int Dune::Fem::StartPass< ArgumentImp, passIdImp, NonBlockingCommunication >::passNum = 0
static

position in pass tree (0 for start pass)


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