Public Member Functions | Static Public Member Functions | List of all members
nonBlockingGaussSeidelSmoother Class Reference

Variant of gaussSeidelSmoother that expects processor boundary cells to be sorted last and so can block later. Only when the cells are actually visited does it need the results to be present. It is expected that there is little benefit to be gained from doing this on a patch by patch basis since the number of processor interfaces is quite small and the overhead of checking whether a processor interface is finished might be quite high (call into mpi). Also this would require a dynamic memory allocation to store the state of the outstanding requests. More...

Inheritance diagram for nonBlockingGaussSeidelSmoother:
Inheritance graph
[legend]
Collaboration diagram for nonBlockingGaussSeidelSmoother:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("nonBlockingGaussSeidel")
 Runtime type information. More...
 
 nonBlockingGaussSeidelSmoother (const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces)
 Construct from components. More...
 
virtual void smooth (scalarField &psi, const scalarField &Source, const direction cmpt, const label nSweeps) const
 Smooth the solution for a given number of sweeps. More...
 
- Public Member Functions inherited from lduMatrix::smoother
virtual const word & type () const =0
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, smoother, symMatrix,(const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces),(fieldName, matrix, interfaceBouCoeffs, interfaceIntCoeffs, interfaces))
 
 declareRunTimeSelectionTable (autoPtr, smoother, asymMatrix,(const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces),(fieldName, matrix, interfaceBouCoeffs, interfaceIntCoeffs, interfaces))
 
 smoother (const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces)
 
virtual ~smoother ()
 Destructor. More...
 
const word & fieldName () const
 
const lduMatrix & matrix () const
 
const FieldField< Field, scalar > & interfaceBouCoeffs () const
 
const FieldField< Field, scalar > & interfaceIntCoeffs () const
 
const lduInterfaceFieldPtrsList & interfaces () const
 

Static Public Member Functions

static void smooth (const word &fieldName, scalarField &psi, const lduMatrix &matrix, const label blockStart, const scalarField &source, const FieldField< Field, scalar > &interfaceBouCoeffs, const lduInterfaceFieldPtrsList &interfaces, const direction cmpt, const label nSweeps)
 Smooth for the given number of sweeps. More...
 
- Static Public Member Functions inherited from lduMatrix::smoother
static word getName (const dictionary &)
 Find the smoother name (directly or from a sub-dictionary) More...
 
static autoPtr< smoother > New (const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls)
 Return a new smoother. More...
 

Additional Inherited Members

- Protected Attributes inherited from lduMatrix::smoother
word fieldName_
 
const lduMatrix & matrix_
 
const FieldField< Field, scalar > & interfaceBouCoeffs_
 
const FieldField< Field, scalar > & interfaceIntCoeffs_
 
const lduInterfaceFieldPtrsList & interfaces_
 

Detailed Description

Variant of gaussSeidelSmoother that expects processor boundary cells to be sorted last and so can block later. Only when the cells are actually visited does it need the results to be present. It is expected that there is little benefit to be gained from doing this on a patch by patch basis since the number of processor interfaces is quite small and the overhead of checking whether a processor interface is finished might be quite high (call into mpi). Also this would require a dynamic memory allocation to store the state of the outstanding requests.

Source files

Definition at line 56 of file nonBlockingGaussSeidelSmoother.H.

Constructor & Destructor Documentation

◆ nonBlockingGaussSeidelSmoother()

nonBlockingGaussSeidelSmoother ( const word &  fieldName,
const lduMatrix &  matrix,
const FieldField< Field, scalar > &  interfaceBouCoeffs,
const FieldField< Field, scalar > &  interfaceIntCoeffs,
const lduInterfaceFieldPtrsList &  interfaces 
)

Construct from components.

Definition at line 47 of file nonBlockingGaussSeidelSmoother.C.

References lduMatrix::diag(), Foam::endl(), forAll, Foam::min(), patchi, Foam::Pout, UPtrList< T >::set(), UPtrList< T >::size(), List< T >::size(), and nonBlockingGaussSeidelSmoother::smooth().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "nonBlockingGaussSeidel"  )

Runtime type information.

◆ smooth() [1/2]

void smooth ( const word &  fieldName,
scalarField &  psi,
const lduMatrix &  matrix,
const label  blockStart,
const scalarField &  source,
const FieldField< Field, scalar > &  interfaceBouCoeffs,
const lduInterfaceFieldPtrsList &  interfaces,
const direction  cmpt,
const label  nSweeps 
)
static

Smooth for the given number of sweeps.

Definition at line 94 of file nonBlockingGaussSeidelSmoother.C.

References UList< T >::begin(), lduMatrix::diag(), forAll, lduMatrix::initMatrixInterfaces(), lduMatrix::lduAddr(), lduMatrix::lower(), FieldField< Field, Type >::negate(), lduAddressing::ownerStartAddr(), patchi, UPtrList< T >::set(), List< T >::size(), Foam::fvc::sweep(), lduMatrix::updateMatrixInterfaces(), lduMatrix::upper(), and lduAddressing::upperAddr().

Referenced by nonBlockingGaussSeidelSmoother::nonBlockingGaussSeidelSmoother().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ smooth() [2/2]

void smooth ( scalarField &  psi,
const scalarField &  Source,
const direction  cmpt,
const label  nSweeps 
) const
virtual

Smooth the solution for a given number of sweeps.

Implements lduMatrix::smoother.

Definition at line 244 of file nonBlockingGaussSeidelSmoother.C.

References Foam::fvc::smooth().

Here is the call graph for this function:
The documentation for this class was generated from the following files: