Public Member Functions | Protected Attributes | List of all members
walberla::pde::RBGSIteration Class Reference

#include <RBGSIteration.h>

Public Member Functions

 RBGSIteration (BlockStorage &blocks, const uint_t iterations, const std::function< void() > &communication, const std::function< void(IBlock *) > &redUpdate, const std::function< void(IBlock *) > &blackUpdate, const std::function< real_t() > &residualNorm, const real_t residualNormThreshold=real_t(0), const uint_t residualCheckFrequency=uint_t(1), const Set< SUID > &requiredSelectors=Set< SUID >::emptySet(), const Set< SUID > &incompatibleSelectors=Set< SUID >::emptySet())
 
void addBoundaryHandling (const std::function< void() > &boundary)
 
void operator() ()
 
uint_t iterationsPerformed () const
 
bool thresholdReached () const
 

Protected Attributes

BlockStorage & blocks_
 
uint_t iterations_
 
real_t residualNormThreshold_
 
uint_t residualCheckFrequency_
 
uint_t iterationsPerformed_
 
bool thresholdReached_
 
std::function< void() > boundary_
 
std::function< void() > communication_
 
std::function< void(IBlock *) > redUpdate_
 
std::function< void(IBlock *) > blackUpdate_
 
std::function< real_t() > residualNorm_
 
Set< SUID > requiredSelectors_
 
Set< SUID > incompatibleSelectors_
 

Constructor & Destructor Documentation

◆ RBGSIteration()

walberla::pde::RBGSIteration::RBGSIteration ( BlockStorage &  blocks,
const uint_t  iterations,
const std::function< void() > &  communication,
const std::function< void(IBlock *) > &  redUpdate,
const std::function< void(IBlock *) > &  blackUpdate,
const std::function< real_t() > &  residualNorm,
const real_t  residualNormThreshold = real_t(0),
const uint_t  residualCheckFrequency = uint_t(1),
const Set< SUID > &  requiredSelectors = Set<SUID>::emptySet(),
const Set< SUID > &  incompatibleSelectors = Set<SUID>::emptySet() 
)
inline

Member Function Documentation

◆ addBoundaryHandling()

void walberla::pde::RBGSIteration::addBoundaryHandling ( const std::function< void() > &  boundary)
inline

◆ iterationsPerformed()

uint_t walberla::pde::RBGSIteration::iterationsPerformed ( ) const
inline

◆ operator()()

void walberla::pde::RBGSIteration::operator() ( )

◆ thresholdReached()

bool walberla::pde::RBGSIteration::thresholdReached ( ) const
inline

Member Data Documentation

◆ blackUpdate_

std::function< void ( IBlock * ) > walberla::pde::RBGSIteration::blackUpdate_
protected

◆ blocks_

BlockStorage& walberla::pde::RBGSIteration::blocks_
protected

◆ boundary_

std::function< void () > walberla::pde::RBGSIteration::boundary_
protected

◆ communication_

std::function< void () > walberla::pde::RBGSIteration::communication_
protected

◆ incompatibleSelectors_

Set<SUID> walberla::pde::RBGSIteration::incompatibleSelectors_
protected

◆ iterations_

uint_t walberla::pde::RBGSIteration::iterations_
protected

◆ iterationsPerformed_

uint_t walberla::pde::RBGSIteration::iterationsPerformed_
protected

◆ redUpdate_

std::function< void ( IBlock * ) > walberla::pde::RBGSIteration::redUpdate_
protected

◆ requiredSelectors_

Set<SUID> walberla::pde::RBGSIteration::requiredSelectors_
protected

◆ residualCheckFrequency_

uint_t walberla::pde::RBGSIteration::residualCheckFrequency_
protected

◆ residualNorm_

std::function< real_t () > walberla::pde::RBGSIteration::residualNorm_
protected

◆ residualNormThreshold_

real_t walberla::pde::RBGSIteration::residualNormThreshold_
protected

◆ thresholdReached_

bool walberla::pde::RBGSIteration::thresholdReached_
protected
The documentation for this class was generated from the following files: