#include <PatchNodeDataOpsReal.h>

Inheritance diagram for SAMRAI::math::PatchNodeDataOpsReal< DIM, TYPE >:

[legend]

Public Member Functions
	PatchNodeDataOpsReal ()

virtual	~PatchNodeDataOpsReal ()

void	copyData (tbox::Pointer< pdat::NodeData< DIM, TYPE > > &dst, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &src, const hier::Box< DIM > &box) const

void	swapData (tbox::Pointer< hier::Patch< DIM > > patch, const int data1_id, const int data2_id) const

void	printData (const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &data, const hier::Box< DIM > &box, std::ostream &s=tbox::plog) const

void	setToScalar (tbox::Pointer< pdat::NodeData< DIM, TYPE > > &dst, const TYPE &alpha, const hier::Box< DIM > &box) const

void	scale (tbox::Pointer< pdat::NodeData< DIM, TYPE > > &dst, const TYPE &alpha, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &src, const hier::Box< DIM > &box) const

void	addScalar (tbox::Pointer< pdat::NodeData< DIM, TYPE > > &dst, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &src, const TYPE &alpha, const hier::Box< DIM > &box) const

void	add (tbox::Pointer< pdat::NodeData< DIM, TYPE > > &dst, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &src1, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &src2, const hier::Box< DIM > &box) const

void	subtract (tbox::Pointer< pdat::NodeData< DIM, TYPE > > &dst, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &src1, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &src2, const hier::Box< DIM > &box) const

void	multiply (tbox::Pointer< pdat::NodeData< DIM, TYPE > > &dst, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &src1, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &src2, const hier::Box< DIM > &box) const

void	divide (tbox::Pointer< pdat::NodeData< DIM, TYPE > > &dst, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &src1, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &src2, const hier::Box< DIM > &box) const

void	reciprocal (tbox::Pointer< pdat::NodeData< DIM, TYPE > > &dst, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &src, const hier::Box< DIM > &box) const

void	linearSum (tbox::Pointer< pdat::NodeData< DIM, TYPE > > &dst, const TYPE &alpha, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &src1, const TYPE &beta, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &src2, const hier::Box< DIM > &box) const

void	axpy (tbox::Pointer< pdat::NodeData< DIM, TYPE > > &dst, const TYPE &alpha, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &src1, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &src2, const hier::Box< DIM > &box) const

void	axmy (tbox::Pointer< pdat::NodeData< DIM, TYPE > > &dst, const TYPE &alpha, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &src1, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &src2, const hier::Box< DIM > &box) const

TYPE	min (const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &data, const hier::Box< DIM > &box) const

TYPE	max (const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &data, const hier::Box< DIM > &box) const

void	setRandomValues (tbox::Pointer< pdat::NodeData< DIM, TYPE > > &dst, const TYPE &width, const TYPE &low, const hier::Box< DIM > &box) const

int	computeConstrProdPos (const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &data1, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &data2, const hier::Box< DIM > &box, const tbox::Pointer< pdat::NodeData< DIM, double > > cvol=((pdat::NodeData< DIM, double > *) NULL)) const

void	compareToScalar (tbox::Pointer< pdat::NodeData< DIM, TYPE > > &dst, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &src, const TYPE &alpha, const hier::Box< DIM > &box, const tbox::Pointer< pdat::NodeData< DIM, double > > cvol=((pdat::NodeData< DIM, double > *) NULL)) const

int	testReciprocal (tbox::Pointer< pdat::NodeData< DIM, TYPE > > &dst, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &src, const hier::Box< DIM > &box, const tbox::Pointer< pdat::NodeData< DIM, double > > cvol=((pdat::NodeData< DIM, double > *) NULL)) const

TYPE	maxPointwiseDivide (const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &numer, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &denom, const hier::Box< DIM > &box) const
	Compute max of "conditional" quotients of two arrays. More...

TYPE	minPointwiseDivide (const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &numer, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &denom, const hier::Box< DIM > &box) const
	Compute min of quotients of two arrays. More...

int	numberOfEntries (const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &data, const hier::Box< DIM > &box) const

double	sumControlVolumes (const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &data, const tbox::Pointer< pdat::NodeData< DIM, double > > &cvol, const hier::Box< DIM > &box) const

void	abs (tbox::Pointer< pdat::NodeData< DIM, TYPE > > &dst, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &src, const hier::Box< DIM > &box) const

double	L1Norm (const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &data, const hier::Box< DIM > &box, const tbox::Pointer< pdat::NodeData< DIM, double > > cvol=NULL) const

double	L2Norm (const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &data, const hier::Box< DIM > &box, const tbox::Pointer< pdat::NodeData< DIM, double > > cvol=NULL) const

double	weightedL2Norm (const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &data, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &weight, const hier::Box< DIM > &box, const tbox::Pointer< pdat::NodeData< DIM, double > > cvol=NULL) const

double	RMSNorm (const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &data, const hier::Box< DIM > &box, const tbox::Pointer< pdat::NodeData< DIM, double > > cvol=NULL) const

double	weightedRMSNorm (const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &data, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &weight, const hier::Box< DIM > &box, const tbox::Pointer< pdat::NodeData< DIM, double > > cvol=NULL) const

double	maxNorm (const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &data, const hier::Box< DIM > &box, const tbox::Pointer< pdat::NodeData< DIM, double > > cvol=NULL) const

TYPE	dot (const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &data1, const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &data2, const hier::Box< DIM > &box, const tbox::Pointer< pdat::NodeData< DIM, double > > cvol=NULL) const

TYPE	integral (const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &data, const hier::Box< DIM > &box, const tbox::Pointer< pdat::NodeData< DIM, double > > vol) const

Private Member Functions
	PatchNodeDataOpsReal (const PatchNodeDataOpsReal< DIM, TYPE > &)

void	operator= (const PatchNodeDataOpsReal< DIM, TYPE > &)

Private Attributes
ArrayDataBasicOps< DIM, TYPE >	d_array_ops

Detailed Description

template<int DIM, class TYPE>
class SAMRAI::math::PatchNodeDataOpsReal< DIM, TYPE >

Class PatchNodeDataOpsReal<DIM> provides a collection of operations to manipulate float and double numerical node-centered patch data. The operations include basic arithmetic, norms and ordering, and assorted miscellaneous operations. With the exception of a few basic routines, this class inherits its interface (and thus its functionality) from the base classes PatchNodeDataBasicOps<DIM>, PatchNodeDataNormOpsReal<DIM>, and PatchNodeDataMiscellaneousOpsReal<DIM> from which it is derived. The name of each of these base classes is indicative of the set of node-centered patch data operations that it provides.

Note that this templated class should only be used to instantiate objects with double or float as the template parameter. A similar set of operations is implemented for complex and integer patch data in the classes PatchNodeDataOpsComplex<DIM> and PatchNodeDataOpsInteger<DIM>, repsectively.

See also: math::PatchNodeDataBasicOps; math::PatchNodeDataMiscellaneousOpsReal; math::PatchNodeDataNormOpsReal

Constructor & Destructor Documentation

◆ PatchNodeDataOpsReal() [1/2]

template<int DIM, class TYPE >

SAMRAI::math::PatchNodeDataOpsReal< DIM, TYPE >::PatchNodeDataOpsReal ( )

Empty constructor and destructor.

◆ ~PatchNodeDataOpsReal()

template<int DIM, class TYPE >

virtual SAMRAI::math::PatchNodeDataOpsReal< DIM, TYPE >::~PatchNodeDataOpsReal ( )

virtual

◆ PatchNodeDataOpsReal() [2/2]

template<int DIM, class TYPE >

SAMRAI::math::PatchNodeDataOpsReal< DIM, TYPE >::PatchNodeDataOpsReal ( const PatchNodeDataOpsReal< DIM, TYPE > & )

private

Member Function Documentation

◆ copyData()

template<int DIM, class TYPE >

void SAMRAI::math::PatchNodeDataOpsReal< DIM, TYPE >::copyData	(	tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	dst,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	src,
		const hier::Box< DIM > &	box
	)		const

Copy dst data to src data over given box.

◆ swapData()

template<int DIM, class TYPE >

void SAMRAI::math::PatchNodeDataOpsReal< DIM, TYPE >::swapData	(	tbox::Pointer< hier::Patch< DIM > >	patch,
		const int	data1_id,
		const int	data2_id
	)		const

Swap pointers for patch data objects. Objects are checked for consistency of depth, box, and ghost box.

◆ printData()

template<int DIM, class TYPE >

void SAMRAI::math::PatchNodeDataOpsReal< DIM, TYPE >::printData	(	const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	data,
		const hier::Box< DIM > &	box,
		std::ostream &	s = `tbox::plog`
	)		const

Print data entries over given box to given output stream.

◆ setToScalar()

template<int DIM, class TYPE >

void SAMRAI::math::PatchNodeDataOpsReal< DIM, TYPE >::setToScalar	(	tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	dst,
		const TYPE &	alpha,
		const hier::Box< DIM > &	box
	)		const

Initialize data to given scalar over given box.

◆ operator=()

template<int DIM, class TYPE >

void SAMRAI::math::PatchNodeDataOpsReal< DIM, TYPE >::operator= ( const PatchNodeDataOpsReal< DIM, TYPE > & )

private

◆ scale()

template<int DIM, class TYPE >

void SAMRAI::math::PatchNodeDataBasicOps< DIM, TYPE >::scale	(	tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	dst,
		const TYPE &	alpha,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	src,
		const hier::Box< DIM > &	box
	)		const

inherited

Set dst = alpha * src, elementwise.

◆ addScalar()

template<int DIM, class TYPE >

void SAMRAI::math::PatchNodeDataBasicOps< DIM, TYPE >::addScalar	(	tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	dst,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	src,
		const TYPE &	alpha,
		const hier::Box< DIM > &	box
	)		const

inherited

Set dst = src + alpha, elementwise.

◆ add()

template<int DIM, class TYPE >

void SAMRAI::math::PatchNodeDataBasicOps< DIM, TYPE >::add	(	tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	dst,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	src1,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	src2,
		const hier::Box< DIM > &	box
	)		const

inherited

Set dst = src1 + src2, elementwise.

◆ subtract()

template<int DIM, class TYPE >

void SAMRAI::math::PatchNodeDataBasicOps< DIM, TYPE >::subtract	(	tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	dst,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	src1,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	src2,
		const hier::Box< DIM > &	box
	)		const

inherited

Set dst = src1 - src2, elementwise.

◆ multiply()

template<int DIM, class TYPE >

void SAMRAI::math::PatchNodeDataBasicOps< DIM, TYPE >::multiply	(	tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	dst,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	src1,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	src2,
		const hier::Box< DIM > &	box
	)		const

inherited

Set dst = src1 * src2, elementwise.

◆ divide()

template<int DIM, class TYPE >

void SAMRAI::math::PatchNodeDataBasicOps< DIM, TYPE >::divide	(	tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	dst,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	src1,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	src2,
		const hier::Box< DIM > &	box
	)		const

inherited

Set dst = src1 / src2, elementwise. No check for division by zero.

◆ reciprocal()

template<int DIM, class TYPE >

void SAMRAI::math::PatchNodeDataBasicOps< DIM, TYPE >::reciprocal	(	tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	dst,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	src,
		const hier::Box< DIM > &	box
	)		const

inherited

Set dst = 1 / src, elementwise. No check for division by zero.

◆ linearSum()

template<int DIM, class TYPE >

void SAMRAI::math::PatchNodeDataBasicOps< DIM, TYPE >::linearSum	(	tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	dst,
		const TYPE &	alpha,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	src1,
		const TYPE &	beta,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	src2,
		const hier::Box< DIM > &	box
	)		const

inherited

Set dst = alpha * src1 + beta * src2, elementwise.

◆ axpy()

template<int DIM, class TYPE >

void SAMRAI::math::PatchNodeDataBasicOps< DIM, TYPE >::axpy	(	tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	dst,
		const TYPE &	alpha,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	src1,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	src2,
		const hier::Box< DIM > &	box
	)		const

inherited

Set dst = alpha * src1 + src2, elementwise.

◆ axmy()

template<int DIM, class TYPE >

void SAMRAI::math::PatchNodeDataBasicOps< DIM, TYPE >::axmy	(	tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	dst,
		const TYPE &	alpha,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	src1,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	src2,
		const hier::Box< DIM > &	box
	)		const

inherited

Set dst = alpha * src1 - src2, elementwise.

◆ min()

template<int DIM, class TYPE >

TYPE SAMRAI::math::PatchNodeDataBasicOps< DIM, TYPE >::min	(	const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	data,
		const hier::Box< DIM > &	box
	)		const

inherited

Return the minimum patch data component entry When the data is complex, the result is the data element with the smallest norm.

◆ max()

template<int DIM, class TYPE >

TYPE SAMRAI::math::PatchNodeDataBasicOps< DIM, TYPE >::max	(	const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	data,
		const hier::Box< DIM > &	box
	)		const

inherited

Return the maximum patch data component entry When the data is complex, the result is the data element with the largest norm.

◆ setRandomValues()

template<int DIM, class TYPE >

void SAMRAI::math::PatchNodeDataBasicOps< DIM, TYPE >::setRandomValues	(	tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	dst,
		const TYPE &	width,
		const TYPE &	low,
		const hier::Box< DIM > &	box
	)		const

inherited

Set patch data to random values. See the operations in the ArrayDataBasicOps<DIM> class for details on the generation of the random values for each data type.

◆ computeConstrProdPos()

template<int DIM, class TYPE >

int SAMRAI::math::PatchNodeDataMiscellaneousOpsReal< DIM, TYPE >::computeConstrProdPos	(	const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	data1,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	data2,
		const hier::Box< DIM > &	box,
		const tbox::Pointer< pdat::NodeData< DIM, double > >	cvol = `((pdat::NodeData< DIM, double > *) NULL)`
	)		const

inherited

Return 1 if \(\|data2_i\| > 0\) and \(data1_i * data2_i \leq 0\), for any \(i\) in the index region, where \(cvol_i > 0\). Otherwise return 0. If the control volume is NULL, all values in the index set are used.

◆ compareToScalar()

template<int DIM, class TYPE >

void SAMRAI::math::PatchNodeDataMiscellaneousOpsReal< DIM, TYPE >::compareToScalar	(	tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	dst,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	src,
		const TYPE &	alpha,
		const hier::Box< DIM > &	box,
		const tbox::Pointer< pdat::NodeData< DIM, double > >	cvol = `((pdat::NodeData< DIM, double > *) NULL)`
	)		const

inherited

Wherever \(cvol_i > 0\) in the index region, set \(dst_i = 1\) if \(\|src_i\| > \alpha\), and \(dst_i = 0\) otherwise. If the control volume is NULL, all values in the index set are considered.

◆ testReciprocal()

template<int DIM, class TYPE >

int SAMRAI::math::PatchNodeDataMiscellaneousOpsReal< DIM, TYPE >::testReciprocal	(	tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	dst,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	src,
		const hier::Box< DIM > &	box,
		const tbox::Pointer< pdat::NodeData< DIM, double > >	cvol = `((pdat::NodeData< DIM, double > *) NULL)`
	)		const

inherited

Wherever \(cvol_i > 0\) in the index region, set \(dst_i = 1/src_i\) if \(src_i \neq 0\), and \(dst_i = 0\) otherwise. If \(dst_i = 0\) anywhere, 0 is the return value. Otherwise 1 is returned. If the control volume all values in the index set are considered.

◆ maxPointwiseDivide()

template<int DIM, class TYPE >

TYPE SAMRAI::math::PatchNodeDataMiscellaneousOpsReal< DIM, TYPE >::maxPointwiseDivide	(	const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	numer,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	denom,
		const hier::Box< DIM > &	box
	)		const

inherited

Return the maximum of pointwise "conditional" quotients of the numerator and denominator.

The "conditional" quotient is defined as |numerator/denominator| where the denominator is nonzero. Otherwise, it is defined as |numerator|.

Note: This method is currently intended to support the PETSc-2.1.6 vector wrapper only. Please do not use it!

◆ minPointwiseDivide()

template<int DIM, class TYPE >

TYPE SAMRAI::math::PatchNodeDataMiscellaneousOpsReal< DIM, TYPE >::minPointwiseDivide	(	const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	numer,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	denom,
		const hier::Box< DIM > &	box
	)		const

inherited

Return the minimum of pointwise quotients of the numerator and denominator.

The quotient is defined as (numerator/denominator) where the denominator is nonzero. When the denominator is zero, the entry is skipped. If the denominator is always zero, the value of tbox::IEEE::getFLT_MAX() is returned (see SAMRAI::tbox::IEEE).

Note: This method is currently intended to support the SUNDIALS vector wrapper only. Please do not use it!

◆ numberOfEntries()

template<int DIM, class TYPE >

int SAMRAI::math::PatchNodeDataNormOpsReal< DIM, TYPE >::numberOfEntries	(	const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	data,
		const hier::Box< DIM > &	box
	)		const

inherited

Return the number of data values for the node-centered data object in the given box. Note that it is assumed that the box refers to the cell-centered index space corresponding to the patch hierarchy.

◆ sumControlVolumes()

template<int DIM, class TYPE >

double SAMRAI::math::PatchNodeDataNormOpsReal< DIM, TYPE >::sumControlVolumes	(	const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	data,
		const tbox::Pointer< pdat::NodeData< DIM, double > > &	cvol,
		const hier::Box< DIM > &	box
	)		const

inherited

Return sum of control volume entries for the node-centered data object.

◆ abs()

template<int DIM, class TYPE >

void SAMRAI::math::PatchNodeDataNormOpsReal< DIM, TYPE >::abs	(	tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	dst,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	src,
		const hier::Box< DIM > &	box
	)		const

inherited

Set destination component to absolute value of source component. That is, each destination entry is set to \(d_i = \| s_i \|\).

◆ L1Norm()

template<int DIM, class TYPE >

double SAMRAI::math::PatchNodeDataNormOpsReal< DIM, TYPE >::L1Norm	(	const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	data,
		const hier::Box< DIM > &	box,
		const tbox::Pointer< pdat::NodeData< DIM, double > >	cvol = `NULL`
	)		const

inherited

Return discrete \(L_1\)-norm of the data using the control volume to weight the contribution of each data entry to the sum. That is, the return value is the sum \(\sum_i ( \| data_i \| cvol_i )\). If the control volume is NULL, the return value is \(\sum_i ( \| data_i \| )\).

◆ L2Norm()

template<int DIM, class TYPE >

double SAMRAI::math::PatchNodeDataNormOpsReal< DIM, TYPE >::L2Norm	(	const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	data,
		const hier::Box< DIM > &	box,
		const tbox::Pointer< pdat::NodeData< DIM, double > >	cvol = `NULL`
	)		const

inherited

Return discrete \(L_2\)-norm of the data using the control volume to weight the contribution of each data entry to the sum. That is, the return value is the sum \(\sqrt{ \sum_i ( (data_i)^2 cvol_i ) }\). If the control volume is NULL, the return value is \(\sqrt{ \sum_i ( (data_i)^2 cvol_i ) }\).

◆ weightedL2Norm()

template<int DIM, class TYPE >

double SAMRAI::math::PatchNodeDataNormOpsReal< DIM, TYPE >::weightedL2Norm	(	const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	data,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	weight,
		const hier::Box< DIM > &	box,
		const tbox::Pointer< pdat::NodeData< DIM, double > >	cvol = `NULL`
	)		const

inherited

Return discrete weighted \(L_2\)-norm of the data using the control volume to weight the contribution of the data and weight entries to the sum. That is, the return value is the sum \(\sqrt{ \sum_i ( (data_i * weight_i)^2 cvol_i ) }\). If the control volume is NULL, the return value is \(\sqrt{ \sum_i ( (data_i * weight_i)^2 ) }\).

◆ RMSNorm()

template<int DIM, class TYPE >

double SAMRAI::math::PatchNodeDataNormOpsReal< DIM, TYPE >::RMSNorm	(	const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	data,
		const hier::Box< DIM > &	box,
		const tbox::Pointer< pdat::NodeData< DIM, double > >	cvol = `NULL`
	)		const

inherited

Return discrete root mean squared norm of the data. If the control volume is not NULL, the return value is the \(L_2\)-norm divided by the square root of the sum of the control volumes. Otherwise, the return value is the \(L_2\)-norm divided by the square root of the number of data entries.

◆ weightedRMSNorm()

template<int DIM, class TYPE >

double SAMRAI::math::PatchNodeDataNormOpsReal< DIM, TYPE >::weightedRMSNorm	(	const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	data,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	weight,
		const hier::Box< DIM > &	box,
		const tbox::Pointer< pdat::NodeData< DIM, double > >	cvol = `NULL`
	)		const

inherited

Return discrete weighted root mean squared norm of the data. If the control volume is not NULL, the return value is the weighted \(L_2\)-norm divided by the square root of the sum of the control volumes. Otherwise, the return value is the weighted \(L_2\)-norm divided by the square root of the number of data entries.

◆ maxNorm()

template<int DIM, class TYPE >

double SAMRAI::math::PatchNodeDataNormOpsReal< DIM, TYPE >::maxNorm	(	const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	data,
		const hier::Box< DIM > &	box,
		const tbox::Pointer< pdat::NodeData< DIM, double > >	cvol = `NULL`
	)		const

inherited

Return the \(\max\)-norm of the data using the control volume to weight the contribution of each data entry to the maximum. That is, the return value is \(\max_i ( \| data_i \| )\), where the max is over the data elements where \(cvol_i > 0\). If the control volume is NULL, it is ignored during the computation of the maximum.

◆ dot()

template<int DIM, class TYPE >

TYPE SAMRAI::math::PatchNodeDataNormOpsReal< DIM, TYPE >::dot	(	const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	data1,
		const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	data2,
		const hier::Box< DIM > &	box,
		const tbox::Pointer< pdat::NodeData< DIM, double > >	cvol = `NULL`
	)		const

inherited

Return the dot product of the two data arrays using the control volume to weight the contribution of each product to the sum. That is, the return value is the sum \(\sum_i ( data1_i * data2_i * cvol_i )\). If the control volume is NULL, it is ignored during the summation.

◆ integral()

template<int DIM, class TYPE >

TYPE SAMRAI::math::PatchNodeDataNormOpsReal< DIM, TYPE >::integral	(	const tbox::Pointer< pdat::NodeData< DIM, TYPE > > &	data,
		const hier::Box< DIM > &	box,
		const tbox::Pointer< pdat::NodeData< DIM, double > >	vol
	)		const

inherited

Return the integral of the function represented by the data array. The return value is the sum \(\sum_i ( data_i * vol_i )\).

Member Data Documentation

◆ d_array_ops

template<int DIM, class TYPE >

ArrayDataBasicOps<DIM,TYPE> SAMRAI::math::PatchNodeDataBasicOps< DIM, TYPE >::d_array_ops

privateinherited

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

/samrai/include/PatchNodeDataOpsReal.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

template<int DIM, class TYPE> class SAMRAI::math::PatchNodeDataOpsReal< DIM, TYPE >

Constructor & Destructor Documentation

◆ PatchNodeDataOpsReal() [1/2]

◆ ~PatchNodeDataOpsReal()

◆ PatchNodeDataOpsReal() [2/2]

Member Function Documentation

◆ copyData()

◆ swapData()

◆ printData()

◆ setToScalar()

◆ operator=()

◆ scale()

◆ addScalar()

◆ add()

◆ subtract()

◆ multiply()

◆ divide()

◆ reciprocal()

◆ linearSum()

◆ axpy()

◆ axmy()

◆ min()

◆ max()

◆ setRandomValues()

◆ computeConstrProdPos()

◆ compareToScalar()

◆ testReciprocal()

◆ maxPointwiseDivide()

◆ minPointwiseDivide()

◆ numberOfEntries()

◆ sumControlVolumes()

◆ abs()

◆ L1Norm()

◆ L2Norm()

◆ weightedL2Norm()

◆ RMSNorm()

◆ weightedRMSNorm()

◆ maxNorm()

◆ dot()

◆ integral()

Member Data Documentation

◆ d_array_ops

template<int DIM, class TYPE>
class SAMRAI::math::PatchNodeDataOpsReal< DIM, TYPE >