Plugins
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Private Attributes | Static Private Attributes | List of all members
ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra > Class Template Reference

#include <fs_equilibirum_finished_condition.hpp>

+ Inheritance diagram for ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >:

Classes

struct  t_pnt_data
 type of point data More...
 

Public Types

typedef ug::GridFunction< TDomain, TAlgebra > grid_function_type
 
- Public Types inherited from ug::ITimeIntegratorObserver< TDomain, TAlgebra >
typedef GridFunction< TDomain, TAlgebra > grid_function_type
 

Public Member Functions

void add_measurement_point (std::vector< number > point)
 
bool check_finished (number time, int step)
 
 FSInEquilibriumFinishedCondition (SmartPtr< grid_function_type > lsf, number equilibrium_factor)
 
void read_measurement_points (const char *filename)
 
void set_equilibrium_factor (number equilibrium_factor)
 
virtual bool step_process (SmartPtr< grid_function_type > u, int step, number time, number dt)
 
- Public Member Functions inherited from ug::ITimeIntegratorObserver< TDomain, TAlgebra >
virtual ~ITimeIntegratorObserver ()
 
- Public Member Functions inherited from ug::IFinishedCondition
virtual ~IFinishedCondition ()
 

Private Attributes

number m_equilibrium_factor
 
ug::d3f::LSPositionZ< grid_function_type > m_height_measurer
 
number m_last_change
 
std::vector< number > m_last_measurement
 
number m_max_change
 
std::vector< t_pnt_data > m_measurement_points
 
int m_number_of_measurement_points
 

Static Private Attributes

static const int dim = TDomain::dim
 

Member Typedef Documentation

◆ grid_function_type

template<class TDomain , class TAlgebra >
typedef ug::GridFunction<TDomain, TAlgebra> ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::grid_function_type

Constructor & Destructor Documentation

◆ FSInEquilibriumFinishedCondition()

template<class TDomain , class TAlgebra >
ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::FSInEquilibriumFinishedCondition ( SmartPtr< grid_function_type >  lsf,
number  equilibrium_factor 
)
inline

References ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::m_last_change, and ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::m_max_change.

Member Function Documentation

◆ add_measurement_point()

template<class TDomain , class TAlgebra >
void ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::add_measurement_point ( std::vector< number >  point)
inline

References ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::dim, ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::m_measurement_points, and p.

Referenced by ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::read_measurement_points().

◆ check_finished()

template<class TDomain , class TAlgebra >
bool ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::check_finished ( number  time,
int  step 
)
inlinevirtual

Reimplemented from ug::IFinishedCondition.

References pcl::ProcessCommunicator::broadcast(), ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::m_equilibrium_factor, ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::m_last_change, ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::m_last_measurement, ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::m_max_change, and pcl::ProcRank().

◆ read_measurement_points()

template<class TDomain , class TAlgebra >
void ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::read_measurement_points ( const char *  filename)
inline

References ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::add_measurement_point(), ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::dim, ug::FindFileInStandardPaths(), UG_COND_THROW, and UG_THROW.

◆ set_equilibrium_factor()

template<class TDomain , class TAlgebra >
void ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::set_equilibrium_factor ( number  equilibrium_factor)
inline

References ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::m_equilibrium_factor.

◆ step_process()

template<class TDomain , class TAlgebra >
virtual bool ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::step_process ( SmartPtr< grid_function_type >  u,
int  step,
number  time,
number  dt 
)
inlinevirtual

Implements ug::ITimeIntegratorObserver< TDomain, TAlgebra >.

References pcl::ProcessCommunicator::allreduce(), ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::m_height_measurer, ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::m_last_change, ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::m_last_measurement, ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::m_max_change, ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::m_measurement_points, PCL_RO_MAX, pcl::ProcRank(), ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::t_pnt_data::valid, ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::t_pnt_data::xy, and ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::t_pnt_data::z.

Member Data Documentation

◆ dim

template<class TDomain , class TAlgebra >
const int ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::dim = TDomain::dim
staticprivate

Referenced by ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::add_measurement_point(), and ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::read_measurement_points().

◆ m_equilibrium_factor

template<class TDomain , class TAlgebra >
number ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::m_equilibrium_factor
private

Referenced by ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::check_finished(), and ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::set_equilibrium_factor().

◆ m_height_measurer

template<class TDomain , class TAlgebra >
ug::d3f::LSPositionZ<grid_function_type> ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::m_height_measurer
private

Referenced by ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::step_process().

◆ m_last_change

template<class TDomain , class TAlgebra >
number ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::m_last_change
private

Referenced by ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::check_finished(), ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::FSInEquilibriumFinishedCondition(), and ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::step_process().

◆ m_last_measurement

template<class TDomain , class TAlgebra >
std::vector<number> ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::m_last_measurement
private

Referenced by ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::check_finished(), and ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::step_process().

◆ m_max_change

template<class TDomain , class TAlgebra >
number ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::m_max_change
private

Referenced by ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::check_finished(), ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::FSInEquilibriumFinishedCondition(), and ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::step_process().

◆ m_measurement_points

template<class TDomain , class TAlgebra >
std::vector<t_pnt_data> ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::m_measurement_points
private

Referenced by ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::add_measurement_point(), and ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::step_process().

◆ m_number_of_measurement_points

template<class TDomain , class TAlgebra >
int ug::FSInEquilibriumFinishedCondition< TDomain, TAlgebra >::m_number_of_measurement_points
private
The documentation for this class was generated from the following file: