ScaledGradient< VectorType, FlagType, dim > Class Template Reference

Computes the scaled gradient. More...

#include <ScaledGradient.h>

Inheritance diagram for ScaledGradient< VectorType, FlagType, dim >:

List of all members.

Public Types
typedef base::vec_grid_fct_type	vec_grid_fct_type
typedef base::grid_fct_type	grid_fct_type
typedef base::flag_fct_type	flag_fct_type
typedef base::max_vector_type	max_vector_type
Public Member Functions
	ScaledGradient ()
virtual	~ScaledGradient ()
virtual void	register_at (ControlDevice &Ctrl)
virtual void	register_at (ControlDevice &Ctrl, const std::string &prefix)
virtual void	update ()
virtual bool	SetFlags (vec_grid_fct_type &u, grid_fct_type &work, flag_fct_type &flags, const int &cnt, const int &Time, const int &Level, const double &t, const FlagType &FlagValue)
virtual bool	FlagByScaledGradient (grid_fct_type &work, flag_fct_type &flags, const int &Time, const int &Level, const DataType &TolVal, const FlagType &FlagValue)
virtual void	OutputName (char *name, int cnt)
Public Attributes
max_vector_type	Tol

---

Detailed Description

template<class VectorType, class FlagType, int dim>
class ScaledGradient< VectorType, FlagType, dim >

Computes the scaled gradient.

Author:

Ralf Deiterding

Version:

1.0

Date:

Jul-2004

---

Member Typedef Documentation

template<class VectorType, class FlagType, int dim>

typedef base::flag_fct_type ScaledGradient< VectorType, FlagType, dim >::flag_fct_type

Reimplemented in F77ScaledGradient< VectorType, FlagType, dim >, and SchemeScaledGradient< SchemeType, FlagType, dim >.

template<class VectorType, class FlagType, int dim>

typedef base::grid_fct_type ScaledGradient< VectorType, FlagType, dim >::grid_fct_type

Reimplemented in F77ScaledGradient< VectorType, FlagType, dim >, and SchemeScaledGradient< SchemeType, FlagType, dim >.

template<class VectorType, class FlagType, int dim>

typedef base::max_vector_type ScaledGradient< VectorType, FlagType, dim >::max_vector_type

template<class VectorType, class FlagType, int dim>

typedef base::vec_grid_fct_type ScaledGradient< VectorType, FlagType, dim >::vec_grid_fct_type

Reimplemented in F77ScaledGradient< VectorType, FlagType, dim >, and SchemeScaledGradient< SchemeType, FlagType, dim >.

---

Constructor & Destructor Documentation

template<class VectorType, class FlagType, int dim>

ScaledGradient< VectorType, FlagType, dim >::ScaledGradient

(

)

[inline]

template<class VectorType, class FlagType, int dim>

virtual ScaledGradient< VectorType, FlagType, dim >::~ScaledGradient

(

)

[inline, virtual]

---

Member Function Documentation

template<class VectorType, class FlagType, int dim>

virtual bool ScaledGradient< VectorType, FlagType, dim >::FlagByScaledGradient	(	grid_fct_type &	work,
		flag_fct_type &	flags,
		const int &	Time,
		const int &	Level,
		const DataType &	TolVal,
		const FlagType &	FlagValue
	)			[inline, virtual]

Referenced by SchemeScaledGradient< SchemeType, FlagType, dim >::SetFlags(), and ScaledGradient< SchemeType::VectorType, FlagType, dim >::SetFlags().

template<class VectorType, class FlagType, int dim>

virtual void ScaledGradient< VectorType, FlagType, dim >::OutputName	(	char *	name,
		int	cnt
	)			[inline, virtual]

Reimplemented in F77ScaledGradient< VectorType, FlagType, dim >, and SchemeScaledGradient< SchemeType, FlagType, dim >.

template<class VectorType, class FlagType, int dim>

virtual void ScaledGradient< VectorType, FlagType, dim >::register_at	(	ControlDevice &	Ctrl,
		const std::string &	prefix
	)			[inline, virtual]

Reimplemented in F77ScaledGradient< VectorType, FlagType, dim >, and SchemeScaledGradient< SchemeType, FlagType, dim >.

template<class VectorType, class FlagType, int dim>

virtual void ScaledGradient< VectorType, FlagType, dim >::register_at

(

ControlDevice &

Ctrl

)

[inline, virtual]

Reimplemented in F77ScaledGradient< VectorType, FlagType, dim >, and SchemeScaledGradient< SchemeType, FlagType, dim >.

Referenced by SchemeScaledGradient< SchemeType, FlagType, dim >::register_at().

template<class VectorType, class FlagType, int dim>

virtual bool ScaledGradient< VectorType, FlagType, dim >::SetFlags	(	vec_grid_fct_type &	u,
		grid_fct_type &	work,
		flag_fct_type &	flags,
		const int &	cnt,
		const int &	Time,
		const int &	Level,
		const double &	t,
		const FlagType &	FlagValue
	)			[inline, virtual]

Reimplemented in F77ScaledGradient< VectorType, FlagType, dim >, and SchemeScaledGradient< SchemeType, FlagType, dim >.

template<class VectorType, class FlagType, int dim>

virtual void ScaledGradient< VectorType, FlagType, dim >::update

(

)

[inline, virtual]

---

Member Data Documentation

template<class VectorType, class FlagType, int dim>

max_vector_type ScaledGradient< VectorType, FlagType, dim >::Tol

Referenced by ScaledGradient< SchemeType::VectorType, FlagType, dim >::register_at(), ScaledGradient< SchemeType::VectorType, FlagType, dim >::ScaledGradient(), SchemeScaledGradient< SchemeType, FlagType, dim >::SetFlags(), ScaledGradient< SchemeType::VectorType, FlagType, dim >::SetFlags(), and ScaledGradient< SchemeType::VectorType, FlagType, dim >::update().

---

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

• amroc/amr/Criteria/ScaledGradient.h