mfem::QuadratureFunction Class Reference

Represents values or vectors of values at quadrature points on a mesh. More...

#include <qfunction.hpp>

Inheritance diagram for mfem::QuadratureFunction:

Collaboration diagram for mfem::QuadratureFunction:

Public Member Functions
	QuadratureFunction ()
	Default constructor, results in an empty vector.
	QuadratureFunction (QuadratureSpaceBase &qspace_, int vdim_=1)
	Create a QuadratureFunction based on the given QuadratureSpaceBase.
	QuadratureFunction (QuadratureSpaceBase *qspace_, int vdim_=1)
	Create a QuadratureFunction based on the given QuadratureSpaceBase.
	QuadratureFunction (QuadratureSpaceBase *qspace_, real_t *qf_data, int vdim_=1)
	Create a QuadratureFunction based on the given QuadratureSpaceBase, using the external (host) data, qf_data.
	QuadratureFunction (const QuadratureFunction &orig)
	Copy constructor. The QuadratureSpace ownership flag, own_qspace, in the new object is set to false.
	QuadratureFunction (Mesh *mesh, std::istream &in)
	Read a QuadratureFunction from the stream in.
int	GetVDim () const
	Get the vector dimension.
void	SetVDim (int vdim_)
	Set the vector dimension, updating the size by calling Vector::SetSize().
QuadratureSpaceBase *	GetSpace ()
	Get the associated QuadratureSpaceBase object.
const QuadratureSpaceBase *	GetSpace () const
	Get the associated QuadratureSpaceBase object (const version).
void	SetSpace (QuadratureSpaceBase *qspace_, int vdim_=-1)
	Change the QuadratureSpaceBase and optionally the vector dimension.
void	SetSpace (QuadratureSpaceBase *qspace_, real_t *qf_data, int vdim_=-1)
	Change the QuadratureSpaceBase, the data array, and optionally the vector dimension.
bool	OwnsSpace ()
	Get the QuadratureSpaceBase ownership flag.
void	SetOwnsSpace (bool own)
	Set the QuadratureSpaceBase ownership flag.
QuadratureFunction &	operator= (real_t value)
	Set this equal to a constant value.
QuadratureFunction &	operator= (const Vector &v)
	Copy the data from v.
void	ProjectGridFunction (const GridFunction &gf)
	Evaluate a grid function at each quadrature point.
void	GetValues (int idx, Vector &values)
	Return all values associated with mesh element idx in a Vector.
void	GetValues (int idx, Vector &values) const
	Return all values associated with mesh element idx in a Vector.
void	GetValues (int idx, const int ip_num, Vector &values)
	Return the quadrature function values at an integration point.
void	GetValues (int idx, const int ip_num, Vector &values) const
	Return the quadrature function values at an integration point.
void	GetValues (int idx, DenseMatrix &values)
	Return all values associated with mesh element idx in a DenseMatrix.
void	GetValues (int idx, DenseMatrix &values) const
	Return all values associated with mesh element idx in a const DenseMatrix.
const IntegrationRule &	GetIntRule (int idx) const
	Get the IntegrationRule associated with entity (element or face) idx.
void	Save (std::ostream &out) const
	Write the QuadratureFunction to the stream out.
void	SaveVTU (std::ostream &out, VTKFormat format=VTKFormat::ASCII, int compression_level=0, const std::string &field_name="u") const
	Write the QuadratureFunction to out in VTU (ParaView) format.
void	SaveVTU (const std::string &filename, VTKFormat format=VTKFormat::ASCII, int compression_level=0, const std::string &field_name="u") const
	Save the QuadratureFunction to a VTU (ParaView) file.
real_t	Integrate () const
	Return the integral of the quadrature function (vdim = 1 only).
void	Integrate (Vector &integrals) const
	Integrate the (potentially vector-valued) quadrature function, storing the results in integrals (length vdim).
virtual	~QuadratureFunction ()
Public Member Functions inherited from mfem::Vector
	Vector ()
	Vector (const Vector &)
	Copy constructor. Allocates a new data array and copies the data.
	Vector (Vector &&v)
	Move constructor. "Steals" data from its argument.
	Vector (int s)
	Creates vector of size s.
	Vector (real_t *data_, int size_)
	Creates a vector referencing an array of doubles, owned by someone else.
	Vector (Vector &base, int base_offset, int size_)
	Create a Vector referencing a sub-vector of the Vector base starting at the given offset, base_offset, and size size_.
	Vector (int size_, MemoryType mt)
	Create a Vector of size size_ using MemoryType mt.
	Vector (int size_, MemoryType h_mt, MemoryType d_mt)
	Create a Vector of size size_ using host MemoryType h_mt and device MemoryType d_mt.
template<int N, typename T = real_t>
	Vector (const T(&values)[N])
	Create a vector using a braced initializer list.
virtual void	UseDevice (bool use_dev) const
	Enable execution of Vector operations using the mfem::Device.
virtual bool	UseDevice () const
	Return the device flag of the Memory object used by the Vector.
void	Load (std::istream **in, int np, int *dim)
	Reads a vector from multiple files.
void	Load (std::istream &in, int Size)
	Load a vector from an input stream.
void	Load (std::istream &in)
	Load a vector from an input stream, reading the size from the stream.
void	SetSize (int s)
	Resize the vector to size s.
void	SetSize (int s, MemoryType mt)
	Resize the vector to size s using MemoryType mt.
void	SetSize (int s, const Vector &v)
	Resize the vector to size s using the MemoryType of v.
void	SetData (real_t *d)
void	SetDataAndSize (real_t *d, int s)
	Set the Vector data and size.
void	NewDataAndSize (real_t *d, int s)
	Set the Vector data and size, deleting the old data, if owned.
void	NewMemoryAndSize (const Memory< real_t > &mem, int s, bool own_mem)
	Reset the Vector to use the given external Memory mem and size s.
void	MakeRef (Vector &base, int offset, int size)
	Reset the Vector to be a reference to a sub-vector of base.
void	MakeRef (Vector &base, int offset)
	Reset the Vector to be a reference to a sub-vector of base without changing its current size.
void	MakeDataOwner () const
	Set the Vector data (host pointer) ownership flag.
void	Destroy ()
	Destroy a vector.
void	DeleteDevice (bool copy_to_host=true)
	Delete the device pointer, if owned. If copy_to_host is true and the data is valid only on device, move it to host before deleting. Invalidates the device memory.
int	Size () const
	Returns the size of the vector.
int	Capacity () const
	Return the size of the currently allocated data array.
real_t *	GetData () const
	Return a pointer to the beginning of the Vector data.
MFEM_DEPRECATED	operator real_t * ()
	Conversion to double *. Deprecated.
MFEM_DEPRECATED	operator const real_t * () const
	Conversion to const double *. Deprecated.
real_t *	begin ()
	STL-like begin.
real_t *	end ()
	STL-like end.
const real_t *	begin () const
	STL-like begin (const version).
const real_t *	end () const
	STL-like end (const version).
Memory< real_t > &	GetMemory ()
	Return a reference to the Memory object used by the Vector.
const Memory< real_t > &	GetMemory () const
	Return a reference to the Memory object used by the Vector, const version.
void	SyncMemory (const Vector &v) const
	Update the memory location of the vector to match v.
void	SyncAliasMemory (const Vector &v) const
	Update the alias memory location of the vector to match v.
bool	OwnsData () const
	Read the Vector data (host pointer) ownership flag.
void	StealData (real_t **p)
	Changes the ownership of the data; after the call the Vector is empty.
real_t *	StealData ()
	Changes the ownership of the data; after the call the Vector is empty.
real_t &	Elem (int i)
	Access Vector entries. Index i = 0 .. size-1.
const real_t &	Elem (int i) const
	Read only access to Vector entries. Index i = 0 .. size-1.
real_t &	operator() (int i)
	Access Vector entries using () for 0-based indexing.
const real_t &	operator() (int i) const
	Read only access to Vector entries using () for 0-based indexing.
real_t &	operator[] (int i)
	Access Vector entries using [] for 0-based indexing.
const real_t &	operator[] (int i) const
	Read only access to Vector entries using [] for 0-based indexing.
real_t	operator* (const real_t *) const
	Dot product with a double * array.
real_t	operator* (const Vector &v) const
	Return the inner-product.
Vector &	operator= (const real_t *v)
	Copy Size() entries from v.
Vector &	operator= (const Vector &v)
	Copy assignment.
Vector &	operator= (Vector &&v)
	Move assignment.
Vector &	operator= (real_t value)
	Redefine '=' for vector = constant.
Vector &	operator*= (real_t c)
Vector &	operator*= (const Vector &v)
	Component-wise scaling: (*this)(i) *= v(i)
Vector &	operator/= (real_t c)
Vector &	operator/= (const Vector &v)
	Component-wise division: (*this)(i) /= v(i)
Vector &	operator-= (real_t c)
Vector &	operator-= (const Vector &v)
Vector &	operator+= (real_t c)
Vector &	operator+= (const Vector &v)
Vector &	Add (const real_t a, const Vector &Va)
	(*this) += a * Va
Vector &	Set (const real_t a, const Vector &x)
	(*this) = a * x
void	SetVector (const Vector &v, int offset)
void	AddSubVector (const Vector &v, int offset)
void	Neg ()
	(*this) = -(*this)
void	Reciprocal ()
	(*this)(i) = 1.0 / (*this)(i)
void	Swap (Vector &other)
	Swap the contents of two Vectors.
void	cross3D (const Vector &vin, Vector &vout) const
void	median (const Vector &lo, const Vector &hi)
	v = median(v,lo,hi) entrywise. Implementation assumes lo <= hi.
void	GetSubVector (const Array< int > &dofs, Vector &elemvect) const
	Extract entries listed in dofs to the output Vector elemvect.
void	GetSubVector (const Array< int > &dofs, real_t *elem_data) const
	Extract entries listed in dofs to the output array elem_data.
void	SetSubVector (const Array< int > &dofs, const real_t value)
	Set the entries listed in dofs to the given value.
void	SetSubVector (const Array< int > &dofs, const Vector &elemvect)
	Set the entries listed in dofs to the values given in the elemvect Vector. Negative dof values cause the -dof-1 position in this Vector to receive the -val from elemvect.
void	SetSubVector (const Array< int > &dofs, real_t *elem_data)
	Set the entries listed in dofs to the values given the , elem_data array. Negative dof values cause the -dof-1 position in this Vector to receive the -val from elem_data.
void	AddElementVector (const Array< int > &dofs, const Vector &elemvect)
	Add elements of the elemvect Vector to the entries listed in dofs. Negative dof values cause the -dof-1 position in this Vector to add the -val from elemvect.
void	AddElementVector (const Array< int > &dofs, real_t *elem_data)
	Add elements of the elem_data array to the entries listed in dofs. Negative dof values cause the -dof-1 position in this Vector to add the -val from elem_data.
void	AddElementVector (const Array< int > &dofs, const real_t a, const Vector &elemvect)
	Add times the elements of the elemvect Vector to the entries listed in dofs. Negative dof values cause the -dof-1 position in this Vector to add the -a*val from elemvect.
void	SetSubVectorComplement (const Array< int > &dofs, const real_t val)
	Set all vector entries NOT in the dofs Array to the given val.
void	Print (std::ostream &out=mfem::out, int width=8) const
	Prints vector to stream out.
void	Print (adios2stream &out, const std::string &variable_name) const
void	Print_HYPRE (std::ostream &out) const
	Prints vector to stream out in HYPRE_Vector format.
void	PrintHash (std::ostream &out) const
	Print the Vector size and hash of its data.
void	Randomize (int seed=0)
	Set random values in the vector.
real_t	Norml2 () const
	Returns the l2 norm of the vector.
real_t	Normlinf () const
	Returns the l_infinity norm of the vector.
real_t	Norml1 () const
	Returns the l_1 norm of the vector.
real_t	Normlp (real_t p) const
	Returns the l_p norm of the vector.
real_t	Max () const
	Returns the maximal element of the vector.
real_t	Min () const
	Returns the minimal element of the vector.
real_t	Sum () const
	Return the sum of the vector entries.
real_t	DistanceSquaredTo (const real_t *p) const
	Compute the square of the Euclidean distance to another vector.
real_t	DistanceSquaredTo (const Vector &p) const
	Compute the square of the Euclidean distance to another vector.
real_t	DistanceTo (const real_t *p) const
	Compute the Euclidean distance to another vector.
real_t	DistanceTo (const Vector &p) const
	Compute the Euclidean distance to another vector.
int	CheckFinite () const
	Count the number of entries in the Vector for which isfinite is false, i.e. the entry is a NaN or +/-Inf.
virtual	~Vector ()
	Destroys vector.
virtual const real_t *	Read (bool on_dev=true) const
	Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), on_dev).
virtual const real_t *	HostRead () const
	Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), false).
virtual real_t *	Write (bool on_dev=true)
	Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), on_dev).
virtual real_t *	HostWrite ()
	Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), false).
virtual real_t *	ReadWrite (bool on_dev=true)
	Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), on_dev).
virtual real_t *	HostReadWrite ()
	Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), false).

Protected Attributes
QuadratureSpaceBase *	qspace
	Associated QuadratureSpaceBase object.
bool	own_qspace
	Does this own the associated QuadratureSpaceBase?
int	vdim
	Vector dimension.
Protected Attributes inherited from mfem::Vector
Memory< real_t >	data
int	size

Detailed Description

Represents values or vectors of values at quadrature points on a mesh.

Definition at line 23 of file qfunction.hpp.

Constructor & Destructor Documentation

QuadratureFunction() [1/6]

mfem::QuadratureFunction::QuadratureFunction ( )

inline

Default constructor, results in an empty vector.

Definition at line 32 of file qfunction.hpp.

QuadratureFunction() [2/6]

mfem::QuadratureFunction::QuadratureFunction ( QuadratureSpaceBase & qspace_, int vdim_ = 1 )

inline

Create a QuadratureFunction based on the given QuadratureSpaceBase.

The QuadratureFunction does not assume ownership of the QuadratureSpaceBase.

Note

The Vector data is not initialized.

Definition at line 39 of file qfunction.hpp.

QuadratureFunction() [3/6]

mfem::QuadratureFunction::QuadratureFunction ( QuadratureSpaceBase * qspace_, int vdim_ = 1 )

inline

Create a QuadratureFunction based on the given QuadratureSpaceBase.

The QuadratureFunction does not assume ownership of the QuadratureSpaceBase.

Warning

qspace_ may not be NULL.

Definition at line 48 of file qfunction.hpp.

QuadratureFunction() [4/6]

mfem::QuadratureFunction::QuadratureFunction ( QuadratureSpaceBase * qspace_, real_t * qf_data, int vdim_ = 1 )

inline

Create a QuadratureFunction based on the given QuadratureSpaceBase, using the external (host) data, qf_data.

The QuadratureFunction does not assume ownership of the QuadratureSpaceBase or the external data.

Warning

qspace_ may not be NULL.

Note

qf_data must be a valid host pointer (see the constructor Vector::Vector(double *, int)).

Definition at line 58 of file qfunction.hpp.

QuadratureFunction() [5/6]

mfem::QuadratureFunction::QuadratureFunction ( const QuadratureFunction & orig )

inline

Copy constructor. The QuadratureSpace ownership flag, own_qspace, in the new object is set to false.

Definition at line 64 of file qfunction.hpp.

QuadratureFunction() [6/6]

mfem::QuadratureFunction::QuadratureFunction	(	Mesh *	mesh,
		std::istream &	in )

Read a QuadratureFunction from the stream in.

The QuadratureFunction assumes ownership of the read QuadratureSpace.

~QuadratureFunction()

virtual mfem::QuadratureFunction::~QuadratureFunction ( )

inlinevirtual

Definition at line 206 of file qfunction.hpp.

Member Function Documentation

GetIntRule()

const IntegrationRule & mfem::QuadratureFunction::GetIntRule ( int idx ) const

inline

Get the IntegrationRule associated with entity (element or face) idx.

Definition at line 176 of file qfunction.hpp.

GetSpace() [1/2]

QuadratureSpaceBase * mfem::QuadratureFunction::GetSpace ( )

inline

Get the associated QuadratureSpaceBase object.

Definition at line 82 of file qfunction.hpp.

GetSpace() [2/2]

const QuadratureSpaceBase * mfem::QuadratureFunction::GetSpace ( ) const

inline

Get the associated QuadratureSpaceBase object (const version).

Definition at line 85 of file qfunction.hpp.

GetValues() [1/6]

void mfem::QuadratureFunction::GetValues ( int idx, const int ip_num, Vector & values )

inline

Return the quadrature function values at an integration point.

The result is stored in the Vector values as a reference to the global values.

Definition at line 236 of file qfunction.hpp.

GetValues() [2/6]

void mfem::QuadratureFunction::GetValues ( int idx, const int ip_num, Vector & values ) const

inline

Return the quadrature function values at an integration point.

The result is stored in the Vector values as a copy to the global values.

Definition at line 243 of file qfunction.hpp.

GetValues() [3/6]

void mfem::QuadratureFunction::GetValues ( int idx, DenseMatrix & values )

inline

Return all values associated with mesh element idx in a DenseMatrix.

The result is stored in the DenseMatrix values as a reference to the global values.

Inside the DenseMatrix values, the (i,j) entry corresponds to the i-th vector component at the j-th quadrature point.

Definition at line 256 of file qfunction.hpp.

GetValues() [4/6]

void mfem::QuadratureFunction::GetValues ( int idx, DenseMatrix & values ) const

inline

Return all values associated with mesh element idx in a const DenseMatrix.

The result is stored in the DenseMatrix values as a copy of the global values.

Inside the DenseMatrix values, the (i,j) entry corresponds to the i-th vector component at the j-th quadrature point.

Definition at line 268 of file qfunction.hpp.

GetValues() [5/6]

void mfem::QuadratureFunction::GetValues ( int idx, Vector & values )

inline

Return all values associated with mesh element idx in a Vector.

The result is stored in the Vector values as a reference to the global values.

Inside the Vector values, the index i+vdim*j corresponds to the i-th vector component at the j-th quadrature point.

Definition at line 214 of file qfunction.hpp.

GetValues() [6/6]

void mfem::QuadratureFunction::GetValues ( int idx, Vector & values ) const

inline

Return all values associated with mesh element idx in a Vector.

The result is stored in the Vector values as a copy of the global values.

Inside the Vector values, the index i+vdim*j corresponds to the i-th vector component at the j-th quadrature point.

Definition at line 222 of file qfunction.hpp.

GetVDim()

int mfem::QuadratureFunction::GetVDim ( ) const

inline

Get the vector dimension.

Definition at line 75 of file qfunction.hpp.

Integrate() [1/2]

real_t mfem::QuadratureFunction::Integrate

(

)

const

Return the integral of the quadrature function (vdim = 1 only).

Integrate() [2/2]

void mfem::QuadratureFunction::Integrate

(

Vector &

integrals

)

const

Integrate the (potentially vector-valued) quadrature function, storing the results in integrals (length vdim).

operator=() [1/2]

QuadratureFunction & mfem::QuadratureFunction::operator=

(

const Vector &

v

)

Copy the data from v.

The size of v must be equal to the size of the associated QuadratureSpaceBase qspace times the QuadratureFunction vector dimension i.e. QuadratureFunction::Size().

operator=() [2/2]

QuadratureFunction & mfem::QuadratureFunction::operator=

(

real_t

value

)

Set this equal to a constant value.

OwnsSpace()

bool mfem::QuadratureFunction::OwnsSpace ( )

inline

Get the QuadratureSpaceBase ownership flag.

Definition at line 112 of file qfunction.hpp.

ProjectGridFunction()

void mfem::QuadratureFunction::ProjectGridFunction

(

const GridFunction &

gf

)

Evaluate a grid function at each quadrature point.

Save()

void mfem::QuadratureFunction::Save

(

std::ostream &

out

)

const

Write the QuadratureFunction to the stream out.

SaveVTU() [1/2]

void mfem::QuadratureFunction::SaveVTU	(	const std::string &	filename,
		VTKFormat	format = VTKFormat::ASCII,
		int	compression_level = 0,
		const std::string &	field_name = "u" ) const

Save the QuadratureFunction to a VTU (ParaView) file.

The extension ".vtu" will be appended to filename.

See also

SaveVTU(std::ostream &out, VTKFormat format=VTKFormat::ASCII, int compression_level=0)

SaveVTU() [2/2]

void mfem::QuadratureFunction::SaveVTU	(	std::ostream &	out,
		VTKFormat	format = VTKFormat::ASCII,
		int	compression_level = 0,
		const std::string &	field_name = "u" ) const

Write the QuadratureFunction to out in VTU (ParaView) format.

The data will be uncompressed if compression_level is zero, or if the format is VTKFormat::ASCII. Otherwise, zlib compression will be used for binary data.

SetOwnsSpace()

void mfem::QuadratureFunction::SetOwnsSpace ( bool own )

inline

Set the QuadratureSpaceBase ownership flag.

Definition at line 115 of file qfunction.hpp.

SetSpace() [1/2]

void mfem::QuadratureFunction::SetSpace ( QuadratureSpaceBase * qspace_, int vdim_ = -1 )

inline

Change the QuadratureSpaceBase and optionally the vector dimension.

If the new QuadratureSpaceBase is different from the current one, the QuadratureFunction will not assume ownership of the new space; otherwise, the ownership flag remains the same.

If the new vector dimension vdim_ < 0, the vector dimension remains the same.

The data size is updated by calling Vector::SetSize().

Definition at line 286 of file qfunction.hpp.

SetSpace() [2/2]

void mfem::QuadratureFunction::SetSpace ( QuadratureSpaceBase * qspace_, real_t * qf_data, int vdim_ = -1 )

inline

Change the QuadratureSpaceBase, the data array, and optionally the vector dimension.

If the new QuadratureSpaceBase is different from the current one, the QuadratureFunction will not assume ownership of the new space; otherwise, the ownership flag remains the same.

If the new vector dimension vdim_ < 0, the vector dimension remains the same.

The data array is replaced by calling Vector::NewDataAndSize().

Definition at line 299 of file qfunction.hpp.

SetVDim()

void mfem::QuadratureFunction::SetVDim ( int vdim_ )

inline

Set the vector dimension, updating the size by calling Vector::SetSize().

Definition at line 78 of file qfunction.hpp.

Member Data Documentation

own_qspace

bool mfem::QuadratureFunction::own_qspace

protected

Does this own the associated QuadratureSpaceBase?

Definition at line 27 of file qfunction.hpp.

qspace

QuadratureSpaceBase* mfem::QuadratureFunction::qspace

protected

Associated QuadratureSpaceBase object.

Definition at line 26 of file qfunction.hpp.

vdim

int mfem::QuadratureFunction::vdim

protected

Vector dimension.

Definition at line 28 of file qfunction.hpp.

---

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

• fem/qfunction.hpp