SolutionHistory< VectorType > Class Template Reference

Developer Documentation: MeltPoolDG::TimeIntegration::SolutionHistory< VectorType > Class Template Reference
Developer Documentation
MeltPoolDG::TimeIntegration::SolutionHistory< VectorType > Class Template Reference

#include <solution_history.hpp>

Public Member Functions

 SolutionHistory ()=default
 
 SolutionHistory (unsigned int size)
 
void resize (const unsigned int size)
 
void apply (std::function< void(VectorType &)> f)
 
void apply_old (std::function< void(VectorType &)> f)
 
void update_ghost_values (const bool check=false) const
 
void zero_out_ghost_values (const bool check=false) const
 
void commit_old_solutions ()
 
void set_recent_old_solution (const VectorType &src)
 
const VectorType & get_recent_old_solution () const
 
VectorType & get_recent_old_solution ()
 
const VectorType & get_current_solution () const
 
VectorType & get_current_solution ()
 
VectorType & get_solution (unsigned int i)
 
const std::vector< std::shared_ptr< VectorType > > & get_old_solutions () const
 
const std::vector< VectorType > & get_all_solutions () const
 
unsigned int size () const
 

Private Attributes

std::vector< VectorType > solutions
 

Constructor & Destructor Documentation

◆ SolutionHistory() [1/2]

template<typename VectorType >
MeltPoolDG::TimeIntegration::SolutionHistory< VectorType >::SolutionHistory ( )
default

◆ SolutionHistory() [2/2]

template<typename VectorType >
MeltPoolDG::TimeIntegration::SolutionHistory< VectorType >::SolutionHistory ( unsigned int  size)
inlineexplicit

Member Function Documentation

◆ apply()

template<typename VectorType >
void MeltPoolDG::TimeIntegration::SolutionHistory< VectorType >::apply ( std::function< void(VectorType &)>  f)
inline

◆ apply_old()

template<typename VectorType >
void MeltPoolDG::TimeIntegration::SolutionHistory< VectorType >::apply_old ( std::function< void(VectorType &)>  f)
inline

◆ commit_old_solutions()

template<typename VectorType >
void MeltPoolDG::TimeIntegration::SolutionHistory< VectorType >::commit_old_solutions ( )
inline

◆ get_all_solutions()

template<typename VectorType >
const std::vector< VectorType > & MeltPoolDG::TimeIntegration::SolutionHistory< VectorType >::get_all_solutions ( ) const
inline

◆ get_current_solution() [1/2]

template<typename VectorType >
VectorType & MeltPoolDG::TimeIntegration::SolutionHistory< VectorType >::get_current_solution ( )
inline

◆ get_current_solution() [2/2]

template<typename VectorType >
const VectorType & MeltPoolDG::TimeIntegration::SolutionHistory< VectorType >::get_current_solution ( ) const
inline

◆ get_old_solutions()

template<typename VectorType >
const std::vector< std::shared_ptr< VectorType > > & MeltPoolDG::TimeIntegration::SolutionHistory< VectorType >::get_old_solutions ( ) const
inline

◆ get_recent_old_solution() [1/2]

template<typename VectorType >
VectorType & MeltPoolDG::TimeIntegration::SolutionHistory< VectorType >::get_recent_old_solution ( )
inline

◆ get_recent_old_solution() [2/2]

template<typename VectorType >
const VectorType & MeltPoolDG::TimeIntegration::SolutionHistory< VectorType >::get_recent_old_solution ( ) const
inline

◆ get_solution()

template<typename VectorType >
VectorType & MeltPoolDG::TimeIntegration::SolutionHistory< VectorType >::get_solution ( unsigned int  i)
inline

Return a reference to the old solution with the number i. Thereby the current solution has the number zero and the number is increasing with the age of the solution.

Parameters
iNumber of the old solution.

◆ resize()

template<typename VectorType >
void MeltPoolDG::TimeIntegration::SolutionHistory< VectorType >::resize ( const unsigned int  size)
inline

◆ set_recent_old_solution()

template<typename VectorType >
void MeltPoolDG::TimeIntegration::SolutionHistory< VectorType >::set_recent_old_solution ( const VectorType &  src)
inline

◆ size()

template<typename VectorType >
unsigned int MeltPoolDG::TimeIntegration::SolutionHistory< VectorType >::size ( ) const
inline

◆ update_ghost_values()

template<typename VectorType >
void MeltPoolDG::TimeIntegration::SolutionHistory< VectorType >::update_ghost_values ( const bool  check = false) const
inline

◆ zero_out_ghost_values()

template<typename VectorType >
void MeltPoolDG::TimeIntegration::SolutionHistory< VectorType >::zero_out_ghost_values ( const bool  check = false) const
inline

Member Data Documentation

◆ solutions

template<typename VectorType >
std::vector<VectorType> MeltPoolDG::TimeIntegration::SolutionHistory< VectorType >::solutions
private

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