solver.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2014 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.

// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_SOLVER_H
#define LIBMESH_SOLVER_H

// Local includes
#include "libmesh/libmesh_common.h"
#include "libmesh/reference_counted_object.h"
#include "libmesh/equation_systems.h"

// C++ includes

namespace libMesh
{

// Forward Declarations
class MeshBase;
class Solver;

// ------------------------------------------------------------
// Solver class definition
class Solver : public ReferenceCountedObject<Solver>
{
protected:

  explicit
  Solver (EquationSystems& es);

  Solver (EquationSystems& es,
          const std::string& name,
          const unsigned int number);


public:

  ~Solver ();

  typedef EquationSystems sys_type;

  virtual void init ();

  virtual void pre_process ();

  virtual void solve ();

  virtual void post_process ();

  const sys_type & system () const { return _system; }

  const MeshBase & mesh () const { return _mesh; }


protected:

  sys_type & system () { return _system; }

  MeshBase & mesh () { return _mesh; }

  sys_type& _system;

  MeshBase& _mesh;
};



// ------------------------------------------------------------
// Solver inline members
inline
Solver::Solver (EquationSystems& es) :
  _system (es),
  _mesh   (es.get_mesh())
{
  libmesh_deprecated();
}



inline
Solver::~Solver ()
{
}



inline
void Solver::init ()
{
  // Initialize the system.
  this->system().init ();
}



inline
void Solver::pre_process ()
{
  //  libMesh::out << "Pre-processing"
  //         << std::endl;
}



inline
void Solver::solve ()
{
  // Perform any necessary pre-processing
  Solver::pre_process ();

  // Solve the system
  this->system().solve ();

  // Perform any necessary post-processing
  Solver::post_process ();
}



inline
void Solver::post_process ()
{
  //  libMesh::out << "Post-processing"
  //         << std::endl;
}

} // namespace libMesh


#endif // LIBMESH_SOLVER_H