transient_system.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2018 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_TRANSIENT_SYSTEM_H
#define LIBMESH_TRANSIENT_SYSTEM_H

// Local Includes
#include "libmesh/system.h"
#include "libmesh/libmesh_config.h"

namespace libMesh
{

// Forward declarations
class LinearImplicitSystem;
class NonlinearImplicitSystem;
class ExplicitSystem;
#ifdef LIBMESH_HAVE_SLEPC
class EigenSystem;
#endif

template <class Base>
class TransientSystem : public Base
{
public:

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

  virtual ~TransientSystem ();

  typedef TransientSystem<Base> sys_type;

  sys_type & system () { return *this; }

  virtual void clear () override;

  virtual std::string system_type () const override;


  //-----------------------------------------------------------------
  // access to the solution data fields

  Number old_solution (const dof_id_type global_dof_number) const;

  Number older_solution (const dof_id_type global_dof_number) const;

  std::unique_ptr<NumericVector<Number>> old_local_solution;

  std::unique_ptr<NumericVector<Number>> older_local_solution;


protected:

  virtual void re_update () override;

private:

  virtual void add_old_vectors ();
};



// -----------------------------------------------------------
// Useful typedefs
typedef TransientSystem<LinearImplicitSystem> TransientImplicitSystem;
typedef TransientSystem<LinearImplicitSystem> TransientLinearImplicitSystem;
typedef TransientSystem<NonlinearImplicitSystem> TransientNonlinearImplicitSystem;
typedef TransientSystem<ExplicitSystem> TransientExplicitSystem;
typedef TransientSystem<System> TransientBaseSystem;
#ifdef LIBMESH_HAVE_SLEPC
typedef TransientSystem<EigenSystem> TransientEigenSystem;
#endif



// ------------------------------------------------------------
// TransientSystem inline methods
template <class Base>
inline
std::string TransientSystem<Base>::system_type () const
{
  std::string type = "Transient";
  type += Base::system_type ();

  return type;
}



} // namespace libMesh




#endif // LIBMESH_TRANSIENT_SYSTEM_H