dftfe::poissonSolverProblemWrapperClass Class Reference

#include <poissonSolverProblemWrapper.h>

Inheritance diagram for dftfe::poissonSolverProblemWrapperClass:

Public Member Functions
	poissonSolverProblemWrapperClass (const dftfe::Int feOrderElectro, const MPI_Comm &mpi_comm)
	Constructor.
distributedCPUVec< double > &	getX ()
	get the reference to x field
void	vmult (distributedCPUVec< double > &Ax, distributedCPUVec< double > &x)
	Compute A matrix multipled by x.
void	computeRhs (distributedCPUVec< double > &rhs)
	Compute right hand side vector for the problem Ax = rhs.
void	precondition_Jacobi (distributedCPUVec< double > &dst, const distributedCPUVec< double > &src, const double omega) const
	Jacobi preconditioning function.
void	distributeX ()
	distribute x to the constrained nodes.
void	subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
void	unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
bool	operator!= (double val) const
	function needed by dealii to mimic SparseMatrix
void	clear ()
template<typename... Args>
void	reinit (Args &&...args)
Public Member Functions inherited from dftfe::dealiiLinearSolverProblem
	dealiiLinearSolverProblem ()
	Constructor.

Private Attributes
poissonSolverProblemObject	d_poissonSolverProblemObject

Constructor & Destructor Documentation

poissonSolverProblemWrapperClass()

dftfe::poissonSolverProblemWrapperClass::poissonSolverProblemWrapperClass ( const dftfe::Int feOrderElectro, const MPI_Comm & mpi_comm )

inline

Constructor.

Member Function Documentation

clear()

void dftfe::poissonSolverProblemWrapperClass::clear ( )

inline

computeRhs()

void dftfe::poissonSolverProblemWrapperClass::computeRhs ( distributedCPUVec< double > & rhs )

inlinevirtual

Compute right hand side vector for the problem Ax = rhs.

Parameters

rhs	vector for the right hand side values

Implements dftfe::dealiiLinearSolverProblem.

distributeX()

void dftfe::poissonSolverProblemWrapperClass::distributeX ( )

inlinevirtual

distribute x to the constrained nodes.

Implements dftfe::dealiiLinearSolverProblem.

getX()

distributedCPUVec< double > & dftfe::poissonSolverProblemWrapperClass::getX ( )

inlinevirtual

get the reference to x field

Returns

reference to x field. Assumes x field data structure is already initialized

Implements dftfe::dealiiLinearSolverProblem.

operator!=()

bool dftfe::poissonSolverProblemWrapperClass::operator!= ( double val ) const

inlinevirtual

function needed by dealii to mimic SparseMatrix

Implements dftfe::dealiiLinearSolverProblem.

precondition_Jacobi()

void dftfe::poissonSolverProblemWrapperClass::precondition_Jacobi ( distributedCPUVec< double > & dst, const distributedCPUVec< double > & src, const double omega ) const

inlinevirtual

Jacobi preconditioning function.

Implements dftfe::dealiiLinearSolverProblem.

reinit()

template<typename... Args>

void dftfe::poissonSolverProblemWrapperClass::reinit ( Args &&... args )

inline

subscribe()

void dftfe::poissonSolverProblemWrapperClass::subscribe ( std::atomic< bool > *const validity, const std::string & identifier = "" ) const

inlinevirtual

function needed by dealii to mimic SparseMatrix for Jacobi preconditioning

Implements dftfe::dealiiLinearSolverProblem.

unsubscribe()

void dftfe::poissonSolverProblemWrapperClass::unsubscribe ( std::atomic< bool > *const validity, const std::string & identifier = "" ) const

inlinevirtual

function needed by dealii to mimic SparseMatrix for Jacobi preconditioning

Implements dftfe::dealiiLinearSolverProblem.

vmult()

void dftfe::poissonSolverProblemWrapperClass::vmult ( distributedCPUVec< double > & Ax, distributedCPUVec< double > & x )

inlinevirtual

Compute A matrix multipled by x.

Implements dftfe::dealiiLinearSolverProblem.

Member Data Documentation

d_poissonSolverProblemObject

poissonSolverProblemObject dftfe::poissonSolverProblemWrapperClass::d_poissonSolverProblemObject

private

---

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

• workspace/include/poissonSolverProblemWrapper.h