#include <fs_measurement.hpp>

Inheritance diagram for ug::FSFileMeasurer< TDomain, TAlgebra >:

Classes
class	BinaryOutput

class	CSVOutput

class	IOutputAdapter

class	ShellOutput

class	StepFileOutput

struct	t_pnt_data
	type of point data More...

class	TableOutput

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)

void	add_measurement_point (std::vector< number > point, number specified_z)

void	enable_binary_output (const char *output_filename)

void	enable_csv_output (const char *output_filename)

void	enable_difference_output (bool differenceOutput)

void	enable_print_output ()

void	enable_step_file_output (const char *output_filename)

void	enable_table_output (const char *output_filename)

void	enable_tsv_output (const char *output_filename)

	FSFileMeasurer (SmartPtr< grid_function_type > lsf)

	FSFileMeasurer (SmartPtr< grid_function_type > lsf, const char *cmp, number zero)

SmartPtr< FSFileMeasurerFinishedObserver< TDomain, TAlgebra > >	get_finished_observer ()

bool	on_finished (SmartPtr< grid_function_type > u, int step, number time, number dt)

void	read_measurement_points (const char *filename, bool includesExpectedZ)

void	set_measurement_interval (int measurement_interval)

void	set_title_text (const char *text)

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

Private Attributes
ug::d3f::LSPositionZ< grid_function_type >	m_height_measurer

int	m_measurement_interval

std::vector< t_pnt_data >	m_measurement_points

std::vector< SmartPtr< IOutputAdapter > >	m_output_adapters

bool	m_outputDifference

std::string	m_titleText

Static Private Attributes
static const int	dim = TDomain::dim

Detailed Description

template<class TDomain, class TAlgebra>
class ug::FSFileMeasurer< TDomain, TAlgebra >

An TimeIntegratorObserver to write the height of the free surface to file, measured at given measurement points.

The measurement points have to be supplied using the add_measurement_point() or the read_measurement_points() method.

Member Typedef Documentation

◆ grid_function_type

template<class TDomain , class TAlgebra >

typedef ug::GridFunction<TDomain, TAlgebra> ug::FSFileMeasurer< TDomain, TAlgebra >::grid_function_type

Constructor & Destructor Documentation

◆ FSFileMeasurer() [1/2]

template<class TDomain , class TAlgebra >

ug::FSFileMeasurer< TDomain, TAlgebra >::FSFileMeasurer ( SmartPtr< grid_function_type > lsf )

inline

◆ FSFileMeasurer() [2/2]

template<class TDomain , class TAlgebra >

ug::FSFileMeasurer< TDomain, TAlgebra >::FSFileMeasurer	(	SmartPtr< grid_function_type >	lsf,
		const char *	cmp,
		number	zero
	)

inline

Member Function Documentation

◆ add_measurement_point() [1/2]

template<class TDomain , class TAlgebra >

void ug::FSFileMeasurer< TDomain, TAlgebra >::add_measurement_point ( std::vector< number > point )

inline

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

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

◆ add_measurement_point() [2/2]

template<class TDomain , class TAlgebra >

void ug::FSFileMeasurer< TDomain, TAlgebra >::add_measurement_point	(	std::vector< number >	point,
		number	specified_z
	)

inline

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

◆ enable_binary_output()

template<class TDomain , class TAlgebra >

void ug::FSFileMeasurer< TDomain, TAlgebra >::enable_binary_output ( const char * output_filename )

inline

References ug::FSFileMeasurer< TDomain, TAlgebra >::m_output_adapters, ug::FSFileMeasurer< TDomain, TAlgebra >::m_outputDifference, make_sp(), and pcl::ProcRank().

◆ enable_csv_output()

template<class TDomain , class TAlgebra >

void ug::FSFileMeasurer< TDomain, TAlgebra >::enable_csv_output ( const char * output_filename )

inline

References ug::FSFileMeasurer< TDomain, TAlgebra >::m_output_adapters, ug::FSFileMeasurer< TDomain, TAlgebra >::m_outputDifference, make_sp(), and pcl::ProcRank().

◆ enable_difference_output()

template<class TDomain , class TAlgebra >

void ug::FSFileMeasurer< TDomain, TAlgebra >::enable_difference_output ( bool differenceOutput )

inline

References ug::FSFileMeasurer< TDomain, TAlgebra >::m_outputDifference.

◆ enable_print_output()

template<class TDomain , class TAlgebra >

void ug::FSFileMeasurer< TDomain, TAlgebra >::enable_print_output ( )

inline

References ug::FSFileMeasurer< TDomain, TAlgebra >::m_output_adapters, ug::FSFileMeasurer< TDomain, TAlgebra >::m_outputDifference, ug::FSFileMeasurer< TDomain, TAlgebra >::m_titleText, make_sp(), and pcl::ProcRank().

◆ enable_step_file_output()

template<class TDomain , class TAlgebra >

void ug::FSFileMeasurer< TDomain, TAlgebra >::enable_step_file_output ( const char * output_filename )

inline

References ug::FSFileMeasurer< TDomain, TAlgebra >::m_output_adapters, ug::FSFileMeasurer< TDomain, TAlgebra >::m_outputDifference, make_sp(), and pcl::ProcRank().

◆ enable_table_output()

template<class TDomain , class TAlgebra >

void ug::FSFileMeasurer< TDomain, TAlgebra >::enable_table_output ( const char * output_filename )

inline

References ug::FSFileMeasurer< TDomain, TAlgebra >::m_measurement_points, ug::FSFileMeasurer< TDomain, TAlgebra >::m_output_adapters, ug::FSFileMeasurer< TDomain, TAlgebra >::m_outputDifference, ug::FSFileMeasurer< TDomain, TAlgebra >::m_titleText, make_sp(), and pcl::ProcRank().

◆ enable_tsv_output()

template<class TDomain , class TAlgebra >

void ug::FSFileMeasurer< TDomain, TAlgebra >::enable_tsv_output ( const char * output_filename )

inline

References ug::FSFileMeasurer< TDomain, TAlgebra >::m_output_adapters, ug::FSFileMeasurer< TDomain, TAlgebra >::m_outputDifference, make_sp(), and pcl::ProcRank().

◆ get_finished_observer()

template<class TDomain , class TAlgebra >

SmartPtr< FSFileMeasurerFinishedObserver< TDomain, TAlgebra > > ug::FSFileMeasurer< TDomain, TAlgebra >::get_finished_observer ( )

inline

References make_sp().

◆ on_finished()

template<class TDomain , class TAlgebra >

bool ug::FSFileMeasurer< TDomain, TAlgebra >::on_finished	(	SmartPtr< grid_function_type >	u,
		int	step,
		number	time,
		number	dt
	)

inline

References ug::FSFileMeasurer< TDomain, TAlgebra >::m_output_adapters, and pcl::ProcRank().

◆ read_measurement_points()

template<class TDomain , class TAlgebra >

void ug::FSFileMeasurer< TDomain, TAlgebra >::read_measurement_points	(	const char *	filename,
		bool	includesExpectedZ
	)

inline

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

◆ set_measurement_interval()

template<class TDomain , class TAlgebra >

void ug::FSFileMeasurer< TDomain, TAlgebra >::set_measurement_interval ( int measurement_interval )

inline

References ug::FSFileMeasurer< TDomain, TAlgebra >::m_measurement_interval.

◆ set_title_text()

template<class TDomain , class TAlgebra >

void ug::FSFileMeasurer< TDomain, TAlgebra >::set_title_text ( const char * text )

inline

References ug::FSFileMeasurer< TDomain, TAlgebra >::m_titleText.

◆ step_process()

template<class TDomain , class TAlgebra >

virtual bool ug::FSFileMeasurer< 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::FSFileMeasurer< TDomain, TAlgebra >::m_height_measurer, ug::FSFileMeasurer< TDomain, TAlgebra >::m_measurement_interval, ug::FSFileMeasurer< TDomain, TAlgebra >::m_measurement_points, ug::FSFileMeasurer< TDomain, TAlgebra >::m_output_adapters, PCL_RO_MAX, pcl::ProcRank(), ug::FSFileMeasurer< TDomain, TAlgebra >::t_pnt_data::valid, ug::FSFileMeasurer< TDomain, TAlgebra >::t_pnt_data::xy, and ug::FSFileMeasurer< TDomain, TAlgebra >::t_pnt_data::z.

Member Data Documentation

◆ dim

template<class TDomain , class TAlgebra >

const int ug::FSFileMeasurer< TDomain, TAlgebra >::dim = TDomain::dim

staticprivate

◆ m_height_measurer

template<class TDomain , class TAlgebra >

ug::d3f::LSPositionZ<grid_function_type> ug::FSFileMeasurer< TDomain, TAlgebra >::m_height_measurer

private

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

◆ m_measurement_interval

template<class TDomain , class TAlgebra >

int ug::FSFileMeasurer< TDomain, TAlgebra >::m_measurement_interval

private

Referenced by ug::FSFileMeasurer< TDomain, TAlgebra >::set_measurement_interval(), and ug::FSFileMeasurer< TDomain, TAlgebra >::step_process().

◆ m_measurement_points

template<class TDomain , class TAlgebra >

std::vector<t_pnt_data> ug::FSFileMeasurer< TDomain, TAlgebra >::m_measurement_points

private

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

◆ m_output_adapters

template<class TDomain , class TAlgebra >

std::vector< SmartPtr<IOutputAdapter> > ug::FSFileMeasurer< TDomain, TAlgebra >::m_output_adapters

private

◆ m_outputDifference

template<class TDomain , class TAlgebra >

bool ug::FSFileMeasurer< TDomain, TAlgebra >::m_outputDifference

private

Referenced by ug::FSFileMeasurer< TDomain, TAlgebra >::enable_binary_output(), ug::FSFileMeasurer< TDomain, TAlgebra >::enable_csv_output(), ug::FSFileMeasurer< TDomain, TAlgebra >::enable_difference_output(), ug::FSFileMeasurer< TDomain, TAlgebra >::enable_print_output(), ug::FSFileMeasurer< TDomain, TAlgebra >::enable_step_file_output(), ug::FSFileMeasurer< TDomain, TAlgebra >::enable_table_output(), and ug::FSFileMeasurer< TDomain, TAlgebra >::enable_tsv_output().

◆ m_titleText

template<class TDomain , class TAlgebra >

std::string ug::FSFileMeasurer< TDomain, TAlgebra >::m_titleText

private

Referenced by ug::FSFileMeasurer< TDomain, TAlgebra >::enable_print_output(), ug::FSFileMeasurer< TDomain, TAlgebra >::enable_table_output(), and ug::FSFileMeasurer< TDomain, TAlgebra >::set_title_text().

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

/home/runner/work/docs/docs/ug4/plugins/d3f/fs_measurement.hpp

Classes

Public Types

Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ grid_function_type

Constructor & Destructor Documentation

◆ FSFileMeasurer() [1/2]

◆ FSFileMeasurer() [2/2]

Member Function Documentation

◆ add_measurement_point() [1/2]

◆ add_measurement_point() [2/2]

◆ enable_binary_output()

◆ enable_csv_output()

◆ enable_difference_output()

◆ enable_print_output()

◆ enable_step_file_output()

◆ enable_table_output()

◆ enable_tsv_output()

◆ get_finished_observer()

◆ on_finished()

◆ read_measurement_points()

◆ set_measurement_interval()

◆ set_title_text()

◆ step_process()

Member Data Documentation

◆ dim

◆ m_height_measurer

◆ m_measurement_interval

◆ m_measurement_points

◆ m_output_adapters

◆ m_outputDifference

◆ m_titleText