JacobiSolver Class Reference

#include <JacobiSolver.h>

Inheritance diagram for JacobiSolver:

Collaboration diagram for JacobiSolver:

Public Member Functions
	JacobiSolver ()
virtual	~JacobiSolver ()
virtual MFRPtr	solve (LinearSystem &ls)
virtual void	cleanup ()
virtual void	smooth (LinearSystem &ls)
	DEFINE_TYPENAME ("JacobiSolver")
Public Member Functions inherited from LinearSolver
	LinearSolver ()

Private Member Functions
void	doSweeps (LinearSystem &ls, const int nSweeps)
	JacobiSolver (const JacobiSolver &)

Additional Inherited Members
Public Attributes inherited from LinearSolver
int	nMaxIterations
int	verbosity
double	relativeTolerance
double	absoluteTolerance

Detailed Description

Solve a linear system using Jacobi iterations

Definition at line 20 of file JacobiSolver.h.

Constructor & Destructor Documentation

JacobiSolver::JacobiSolver

(

)

Definition at line 15 of file JacobiSolver.cpp.

References logCtor.

{
  logCtor();
  
}

JacobiSolver::~JacobiSolver ( )

virtual

Definition at line 21 of file JacobiSolver.cpp.

References logDtor.

{
  logDtor();
}

JacobiSolver::JacobiSolver ( const JacobiSolver &  )

private

Member Function Documentation

void JacobiSolver::cleanup ( )

virtual

Implements LinearSolver.

Definition at line 42 of file JacobiSolver.cpp.

{
}

JacobiSolver::DEFINE_TYPENAME

(

"JacobiSolver"

)

void JacobiSolver::doSweeps ( LinearSystem &  ls, const int  nSweeps  )

private

Definition at line 27 of file JacobiSolver.cpp.

References LinearSystem::getB(), LinearSystem::getDelta(), LinearSystem::getMatrix(), LinearSystem::getResidual(), and MultiFieldMatrix::Jacobi().

Referenced by smooth(), and solve().

{
  const MultiFieldMatrix& m = ls.getMatrix();
  MultiField& delta = ls.getDelta();
  const MultiField& b = ls.getB();
  MultiField& r = ls.getResidual();

  for(int i=0; i<nSweeps; i++)
  {
      m.Jacobi(delta,b,r);
  }
}

void JacobiSolver::smooth ( LinearSystem &  ls )

virtual

Implements LinearSolver.

Definition at line 98 of file JacobiSolver.cpp.

References doSweeps().

{
  doSweeps(ls,2);
}

MFRPtr JacobiSolver::solve ( LinearSystem &  ls )

virtual

Implements LinearSolver.

Definition at line 47 of file JacobiSolver.cpp.

References LinearSolver::absoluteTolerance, MultiFieldMatrix::computeResidual(), doSweeps(), LinearSystem::getB(), LinearSystem::getDelta(), LinearSystem::getMatrix(), MultiField::getOneNorm(), LinearSystem::getResidual(), LinearSolver::nMaxIterations, LinearSolver::relativeTolerance, and LinearSolver::verbosity.

{
  ls.getMatrix().computeResidual(ls.getDelta(),
                                 ls.getB(),
                                 ls.getResidual());
  MFRPtr rNorm0(ls.getResidual().getOneNorm());

#ifdef FVM_PARALLEL
  if (verbosity >0 && MPI::COMM_WORLD.Get_rank() == 0 )
    cout << "0: " << *rNorm0 << endl;
#endif

#ifndef FVM_PARALLEL
   if ( verbosity > 0 )
      cout << "0: " << *rNorm0 << endl;
#endif

  if (*rNorm0 < absoluteTolerance )
    return rNorm0;

  for(int i=1; i<nMaxIterations; i++)
  {
      doSweeps(ls,1);

      ls.getMatrix().computeResidual(ls.getDelta(),
                                     ls.getB(),
                                     ls.getResidual());
      MFRPtr rNorm(ls.getResidual().getOneNorm());
      MFRPtr normRatio((*rNorm)/(*rNorm0));

#ifndef FVM_PARALLEL
      if (verbosity >0  )
        cout << i << ": " <<  *rNorm << endl;
#endif


#ifdef FVM_PARALLEL
     if (*rNorm < absoluteTolerance || *normRatio < relativeTolerance || i == nMaxIterations-1)
        if (verbosity >0 && MPI::COMM_WORLD.Get_rank() == 0  )
        cout <<i << ": " <<  *rNorm << endl;
#endif

      if (*rNorm < absoluteTolerance || *normRatio < relativeTolerance)
         break;
      
  }
  return rNorm0;
}

---

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

• JacobiSolver.h
• JacobiSolver.cpp