walberla::pde::JacobiIteration Class Reference

#include <JacobiIteration.h>

Public Member Functions

 JacobiIteration (BlockStorage &blocks, const uint_t iterations, const std::function< void() > &communication, const std::function< void(IBlock *) > &jacobi, 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() ()
 

Protected Attributes

BlockStorageblocks_
 
uint_t iterations_
 
real_t residualNormThreshold_
 
uint_t residualCheckFrequency_
 
std::function< void() > boundary_
 
std::function< void() > communication_
 
std::function< void(IBlock *) > jacobi_
 
std::function< real_t() > residualNorm_
 
Set< SUID > requiredSelectors_
 
Set< SUID > incompatibleSelectors_
 

Constructor & Destructor Documentation

◆ JacobiIteration()

walberla::pde::JacobiIteration::JacobiIteration ( BlockStorage blocks,
const uint_t  iterations,
const std::function< void() > &  communication,
const std::function< void(IBlock *) > &  jacobi,
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::JacobiIteration::addBoundaryHandling ( const std::function< void() > &  boundary)
inline

◆ operator()()

void walberla::pde::JacobiIteration::operator() ( )

Member Data Documentation

◆ blocks_

BlockStorage& walberla::pde::JacobiIteration::blocks_
protected

◆ boundary_

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

◆ communication_

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

◆ incompatibleSelectors_

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

◆ iterations_

uint_t walberla::pde::JacobiIteration::iterations_
protected

◆ jacobi_

std::function< void ( IBlock * ) > walberla::pde::JacobiIteration::jacobi_
protected

◆ requiredSelectors_

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

◆ residualCheckFrequency_

uint_t walberla::pde::JacobiIteration::residualCheckFrequency_
protected

◆ residualNorm_

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

◆ residualNormThreshold_

real_t walberla::pde::JacobiIteration::residualNormThreshold_
protected

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