libMesh
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Private Member Functions | List of all members
libMesh::TransientSystem< Base > Class Template Reference

This class provides a specific system class. More...

#include <transient_system.h>

Inheritance diagram for libMesh::TransientSystem< Base >:
[legend]

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_typesystem ()
 
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 >

This class provides a specific system class.

It aims at transient systems, offering nothing more than just the essentials needed to solve a system.

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 51 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 71 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.

◆ ~TransientSystem()

template<class Base>
virtual libMesh::TransientSystem< Base >::~TransientSystem ( )
virtual

Destructor.

Member Function Documentation

◆ add_old_vectors()

template<class Base>
virtual void libMesh::TransientSystem< Base >::add_old_vectors ( )
privatevirtual

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

◆ clear()

template<class Base>
virtual void libMesh::TransientSystem< Base >::clear ( )
overridevirtual

Clear all the data structures associated with the system.

Reimplemented in libMesh::TransientRBConstruction.

◆ 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.

◆ 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.

◆ re_update()

template<class Base>
virtual 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.

◆ system()

template<class Base>
sys_type& libMesh::TransientSystem< Base >::system ( )
Returns
A reference to *this.

Definition at line 76 of file transient_system.h.

76 { return *this; }

◆ system_type()

template<class Base >
std::string libMesh::TransientSystem< Base >::system_type ( ) const
overridevirtual
Returns
"Transient" prepended to T::system_type(). Helps in identifying the system type in an equation system file.

Definition at line 160 of file transient_system.h.

161 {
162  std::string type = "Transient";
163  type += Base::system_type ();
164 
165  return type;
166 }

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 113 of file transient_system.h.

◆ 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 121 of file transient_system.h.


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