Pscf::Rpc::BFieldComparison Class Reference

Comparator for fields in symmetry-adapted basis format. More...

#include <BFieldComparison.h>

Inheritance diagram for Pscf::Rpc::BFieldComparison:

Public Member Functions
	BFieldComparison (int begin=0)
	Constructor.
Public Member Functions inherited from Pscf::FieldComparison< DArray< double > >
	FieldComparison (int begin=0)
	Default constructor.
double	compare (DArray< double > const &a, DArray< double > const &b)
	Compare individual fields.
double	maxDiff () const
	Return the precomputed maximum element-by-element difference.
double	rmsDiff () const
	Return the precomputed root-mean-squared difference.

Detailed Description

Comparator for fields in symmetry-adapted basis format.

Definition at line 24 of file rpc/field/BFieldComparison.h.

Constructor & Destructor Documentation

BFieldComparison()

Pscf::Rpc::BFieldComparison::BFieldComparison

(

int

begin = 0

)

Constructor.

The basis function with index 0 in a symmetry adapted basis is always a spatially homogeneous function, i.e., a constant. In some situations, we may be interested in determining whether two fields are equivalent to within a constant.

Set begin = 0 to include the coefficient of the first basis function in the comparison, thus determining how close to fields are to being strictly equal.

Set begin = 1 to exclude the coefficient of the first basis function, thus comparing only deviatoric parts of the fields.

Parameters

begin

index of first element to include in comparison.

Definition at line 14 of file rpc/field/BFieldComparison.cpp.

References Pscf::FieldComparison< DArray< double > >::FieldComparison().

---

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

• rpc/field/BFieldComparison.h
• rpc/field/BFieldComparison.cpp