libMesh::TransientSystem< Base > Class Template Reference

Manages storage and variables for transient systems. More...

#include <transient_system.h>

Inheritance diagram for libMesh::TransientSystem< Base >:

Public Types
typedef TransientSystem< Base >	sys_type
	The type of system. More...

Public Member Functions
	TransientSystem (EquationSystems &es, const std::string &name, const unsigned int number)
	Constructor. More...
virtual	~TransientSystem ()
	Destructor. More...
sys_type &	system ()
virtual void	clear () override
	Clear all the data structures associated with the system. More...
virtual std::string	system_type () const override
Number	old_solution (const dof_id_type global_dof_number) const
Number	older_solution (const dof_id_type global_dof_number) const

Public Attributes
std::unique_ptr< NumericVector< Number > >	old_local_solution
	All the values I need to compute my contribution to the simulation at hand. More...
std::unique_ptr< NumericVector< Number > >	older_local_solution
	All the values I need to compute my contribution to the simulation at hand. More...

Protected Member Functions
virtual void	re_update () override
	Re-update the local values when the mesh has changed. More...

Private Member Functions
virtual void	add_old_vectors ()
	Helper function for (re-)adding old and older solution vectors. More...

Detailed Description

template<class Base>
class libMesh::TransientSystem< Base >

Manages storage and variables for transient systems.

This class is a specialized system for solving transient systems, e.g., systems with a time dependency. It provides appropriate storage, manages variables and ensures consistency for these systems.

This template class adds the functionality to manage, in addition to the solution vector, an old solution and an older solution vector. These vectors are useful to simulate transient systems.

Note

Additional vectors/matrices can be added via parent class interfaces.

Author

Benjamin S. Kirk

Date

2004

Used for solving transient systems of equations.

Definition at line 57 of file transient_system.h.

Member Typedef Documentation

sys_type

template<class Base>

typedef TransientSystem<Base> libMesh::TransientSystem< Base >::sys_type

The type of system.

Definition at line 77 of file transient_system.h.

Constructor & Destructor Documentation

TransientSystem()

template<class Base >

libMesh::TransientSystem< Base >::TransientSystem	(	EquationSystems &	es,
		const std::string &	name,
		const unsigned int	number
	)

Constructor.

Initializes required data structures.

Definition at line 39 of file transient_system.C.

                                                                      :
 
  Base                 (es, name_in, number_in)
{
  this->add_old_vectors();
}

~TransientSystem()

template<class Base >

libMesh::TransientSystem< Base >::~TransientSystem ( )

virtual

Destructor.

Definition at line 51 of file transient_system.C.

{
  this->clear();
 
  // We still have std::unique_ptrs for API compatibility, but
  // now that we're System::add_vector()ing these, we can trust
  // the base class to handle memory management
  old_local_solution.release();
  older_local_solution.release();
}

Member Function Documentation

add_old_vectors()

template<class Base >

void libMesh::TransientSystem< Base >::add_old_vectors ( )

privatevirtual

Helper function for (re-)adding old and older solution vectors.

Definition at line 146 of file transient_system.C.

{
#ifdef LIBMESH_ENABLE_GHOSTED
  old_local_solution =
    std::unique_ptr<NumericVector<Number>>
    (&(this->add_vector("_transient_old_local_solution", true, GHOSTED)));
  older_local_solution =
    std::unique_ptr<NumericVector<Number>>
    (&(this->add_vector("_transient_older_local_solution", true, GHOSTED)));
#else
  old_local_solution =
    std::unique_ptr<NumericVector<Number>>
    (&(this->add_vector("_transient_old_local_solution", true, SERIAL)));
  older_local_solution =
    std::unique_ptr<NumericVector<Number>>
    (&(this->add_vector("_transient_older_local_solution", true, SERIAL)));
#endif
}

clear()

template<class Base >

void libMesh::TransientSystem< Base >::clear ( )

overridevirtual

Clear all the data structures associated with the system.

Reimplemented in libMesh::TransientRBConstruction.

Definition at line 65 of file transient_system.C.

{
  // clear the parent data
  Base::clear();
 
  // the old & older local solutions
  // are now deleted by System!
  // old_local_solution->clear();
  // older_local_solution->clear();
 
  // FIXME: This preserves maximum backwards compatibility,
  // but is probably grossly unnecessary:
  old_local_solution.release();
  older_local_solution.release();
 
  // Restore us to a "basic" state
  this->add_old_vectors();
}

old_solution()

template<class Base >

Number libMesh::TransientSystem< Base >::old_solution

(

const dof_id_type

global_dof_number

)

const

Returns

The old solution (at the previous timestep) for the specified global DOF.

Definition at line 122 of file transient_system.C.

{
  // Check the sizes
  libmesh_assert_less (global_dof_number, this->get_dof_map().n_dofs());
  libmesh_assert_less (global_dof_number, old_local_solution->size());
 
  return (*old_local_solution)(global_dof_number);
}

Referenced by assemble_cd(), and assemble_stokes().

older_solution()

template<class Base >

Number libMesh::TransientSystem< Base >::older_solution

(

const dof_id_type

global_dof_number

)

const

Returns

The older solution (two timesteps ago) for the specified global DOF.

Definition at line 134 of file transient_system.C.

{
  // Check the sizes
  libmesh_assert_less (global_dof_number, this->get_dof_map().n_dofs());
  libmesh_assert_less (global_dof_number, older_local_solution->size());
 
  return (*older_local_solution)(global_dof_number);
}

re_update()

template<class Base >

void libMesh::TransientSystem< Base >::re_update ( )

overrideprotectedvirtual

Re-update the local values when the mesh has changed.

This method takes the data updated by update() and makes it up-to-date on the current mesh.

Definition at line 87 of file transient_system.C.

{
  // re_update the parent system
  Base::re_update ();
 
  const std::vector<dof_id_type> & send_list = this->get_dof_map().get_send_list ();
 
  const dof_id_type first_local_dof = Base::get_dof_map().first_dof();
  const dof_id_type end_local_dof  = Base::get_dof_map().end_dof();
 
  // Check sizes
  libmesh_assert_greater_equal (end_local_dof, first_local_dof);
  libmesh_assert_greater_equal (older_local_solution->size(), send_list.size());
  libmesh_assert_greater_equal (old_local_solution->size(), send_list.size());
 
  // Even if we don't have to do anything ourselves, localize() may
  // use parallel_only tools
  // if (first_local_dof == end_local_dof)
  //   return;
 
  // Update the old & older solutions with the send_list,
  // which may have changed since their last update.
  older_local_solution->localize (first_local_dof,
                                  end_local_dof-1,
                                  send_list);
 
  old_local_solution->localize (first_local_dof,
                                end_local_dof-1,
                                send_list);
}

system()

template<class Base>

sys_type& libMesh::TransientSystem< Base >::system ( )

inline

Returns

A reference to *this.

Definition at line 82 of file transient_system.h.

{ return *this; }

system_type()

template<class Base >

std::string libMesh::TransientSystem< Base >::system_type ( ) const

inlineoverridevirtual

Returns

"Transient" prepended to T::system_type(). Helps in identifying the system type in an equation system file.

Definition at line 166 of file transient_system.h.

{
  std::string type = "Transient";
  type += Base::system_type ();
 
  return type;
}

Member Data Documentation

old_local_solution

template<class Base>

std::unique_ptr<NumericVector<Number> > libMesh::TransientSystem< Base >::old_local_solution

All the values I need to compute my contribution to the simulation at hand.

Think of this as the current solution with any ghost values needed from other processors.

Definition at line 119 of file transient_system.h.

Referenced by main(), run_timestepping(), SystemsTest::testProjectCube(), SystemsTest::testProjectLine(), SystemsTest::testProjectSquare(), and SystemsTest::tripleValueTest().

older_local_solution

template<class Base>

std::unique_ptr<NumericVector<Number> > libMesh::TransientSystem< Base >::older_local_solution

All the values I need to compute my contribution to the simulation at hand.

Think of this as the current solution with any ghost values needed from other processors.

Definition at line 127 of file transient_system.h.

Referenced by run_timestepping(), SystemsTest::testProjectCube(), SystemsTest::testProjectLine(), SystemsTest::testProjectSquare(), and SystemsTest::tripleValueTest().

---

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

• include/systems/transient_system.h
• src/systems/transient_system.C