Class to represent a coefficient evaluated at quadrature points. More...

#include <coefficient.hpp>

Inheritance diagram for mfem::CoefficientVector:

Collaboration diagram for mfem::CoefficientVector:

Public Member Functions
	CoefficientVector (QuadratureSpaceBase &qs_, CoefficientStorage storage_=CoefficientStorage::FULL)
	Create an empty CoefficientVector.

	CoefficientVector (Coefficient *coeff, QuadratureSpaceBase &qs, CoefficientStorage storage_=CoefficientStorage::FULL)
	Create a CoefficientVector from the given Coefficient and QuadratureSpaceBase.

	CoefficientVector (Coefficient &coeff, QuadratureSpaceBase &qs, CoefficientStorage storage_=CoefficientStorage::FULL)
	Create a CoefficientVector from the given Coefficient and QuadratureSpaceBase.

	CoefficientVector (VectorCoefficient &coeff, QuadratureSpaceBase &qs, CoefficientStorage storage_=CoefficientStorage::FULL)
	Create a CoefficientVector from the given VectorCoefficient and QuadratureSpaceBase.

	CoefficientVector (MatrixCoefficient &coeff, QuadratureSpaceBase &qs, CoefficientStorage storage_=CoefficientStorage::FULL)
	Create a CoefficientVector from the given MatrixCoefficient and QuadratureSpaceBase.

void	Project (Coefficient &coeff)
	Evaluate the given Coefficient at the quadrature points defined by qs.

void	Project (VectorCoefficient &coeff)
	Evaluate the given VectorCoefficient at the quadrature points defined by qs.

void	Project (MatrixCoefficient &coeff, bool transpose=false)
	Evaluate the given MatrixCoefficient at the quadrature points defined by qs.

void	ProjectTranspose (MatrixCoefficient &coeff)
	Project the transpose of coeff.

void	MakeRef (const QuadratureFunction &qf_)
	Make this vector a reference to the given QuadratureFunction.

void	SetConstant (real_t constant)
	Set this vector to the given constant.

void	SetConstant (const Vector &constant)
	Set this vector to the given constant vector.

void	SetConstant (const DenseMatrix &constant)
	Set this vector to the given constant matrix.

void	SetConstant (const DenseSymmetricMatrix &constant)
	Set this vector to the given constant symmetric matrix.

int	GetVDim () const
	Return the number of values per quadrature point.

	~CoefficientVector ()

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 -aval 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
CoefficientStorage	storage
	Storage optimizations (see CoefficientStorage).

int	vdim
	Number of values per quadrature point.

QuadratureSpaceBase &	qs
	Associated QuadratureSpaceBase.

QuadratureFunction *	qf
	Internal QuadratureFunction (owned, may be NULL).

Protected Attributes inherited from mfem::Vector
Memory< real_t >	data

int	size

Detailed Description

Class to represent a coefficient evaluated at quadrature points.

In the general case, a CoefficientVector is the same as a QuadratureFunction with a coefficient projected onto it.

This class allows for some "compression" of the coefficient data, according to the storage flags given by CoefficientStorage. For example, constant coefficients can be stored using only vdim values, and symmetric matrices can be stored using e.g. the upper triangular part of the matrix.

Definition at line 2316 of file coefficient.hpp.

Constructor & Destructor Documentation

◆ CoefficientVector() [1/5]

mfem::CoefficientVector::CoefficientVector	(	QuadratureSpaceBase &	qs_,
		CoefficientStorage	storage_ = CoefficientStorage::FULL )

Create an empty CoefficientVector.

Definition at line 1654 of file coefficient.cpp.

◆ CoefficientVector() [2/5]

mfem::CoefficientVector::CoefficientVector	(	Coefficient *	coeff,
		QuadratureSpaceBase &	qs,
		CoefficientStorage	storage_ = CoefficientStorage::FULL )

Create a CoefficientVector from the given Coefficient and QuadratureSpaceBase.

If coeff is NULL, it will be interpreted as a constant with value one.

See also: CoefficientStorage for a description of storage_.

Definition at line 1661 of file coefficient.cpp.

◆ CoefficientVector() [3/5]

mfem::CoefficientVector::CoefficientVector	(	Coefficient &	coeff,
		QuadratureSpaceBase &	qs,
		CoefficientStorage	storage_ = CoefficientStorage::FULL )

Create a CoefficientVector from the given Coefficient and QuadratureSpaceBase.

See also: CoefficientStorage for a description of storage_.

Definition at line 1676 of file coefficient.cpp.

◆ CoefficientVector() [4/5]

mfem::CoefficientVector::CoefficientVector	(	VectorCoefficient &	coeff,
		QuadratureSpaceBase &	qs,
		CoefficientStorage	storage_ = CoefficientStorage::FULL )

Create a CoefficientVector from the given VectorCoefficient and QuadratureSpaceBase.

See also: CoefficientStorage for a description of storage_.

Definition at line 1684 of file coefficient.cpp.

◆ CoefficientVector() [5/5]

mfem::CoefficientVector::CoefficientVector	(	MatrixCoefficient &	coeff,
		QuadratureSpaceBase &	qs,
		CoefficientStorage	storage_ = CoefficientStorage::FULL )

Create a CoefficientVector from the given MatrixCoefficient and QuadratureSpaceBase.

See also: CoefficientStorage for a description of storage_.

Definition at line 1692 of file coefficient.cpp.

◆ ~CoefficientVector()

mfem::CoefficientVector::~CoefficientVector ( )

Definition at line 1845 of file coefficient.cpp.

Member Function Documentation

◆ GetVDim()

int mfem::CoefficientVector::GetVDim ( ) const

Return the number of values per quadrature point.

Definition at line 1843 of file coefficient.cpp.

◆ MakeRef()

void mfem::CoefficientVector::MakeRef ( const QuadratureFunction & qf_ )

Make this vector a reference to the given QuadratureFunction.

Definition at line 1773 of file coefficient.cpp.

◆ Project() [1/3]

void mfem::CoefficientVector::Project ( Coefficient & coeff )

Evaluate the given Coefficient at the quadrature points defined by qs.

Definition at line 1700 of file coefficient.cpp.

◆ Project() [2/3]

void mfem::CoefficientVector::Project	(	MatrixCoefficient &	coeff,
		bool	transpose = false )

Evaluate the given MatrixCoefficient at the quadrature points defined by qs.

See also: CoefficientVector for a description of the compress argument.

Definition at line 1741 of file coefficient.cpp.

◆ Project() [3/3]

void mfem::CoefficientVector::Project ( VectorCoefficient & coeff )

Evaluate the given VectorCoefficient at the quadrature points defined by qs.

See also: CoefficientVector for a description of the compress argument.

Definition at line 1720 of file coefficient.cpp.

◆ ProjectTranspose()

void mfem::CoefficientVector::ProjectTranspose ( MatrixCoefficient & coeff )

Project the transpose of coeff.

See also: Project(MatrixCoefficient&, QuadratureSpace&, bool, bool)

Definition at line 1768 of file coefficient.cpp.

◆ SetConstant() [1/4]

void mfem::CoefficientVector::SetConstant ( const DenseMatrix & constant )

Set this vector to the given constant matrix.

Definition at line 1806 of file coefficient.cpp.

◆ SetConstant() [2/4]

void mfem::CoefficientVector::SetConstant ( const DenseSymmetricMatrix & constant )

Set this vector to the given constant symmetric matrix.

Definition at line 1825 of file coefficient.cpp.

◆ SetConstant() [3/4]

void mfem::CoefficientVector::SetConstant ( const Vector & constant )

Set this vector to the given constant vector.

Definition at line 1792 of file coefficient.cpp.

◆ SetConstant() [4/4]

void mfem::CoefficientVector::SetConstant ( real_t constant )

Set this vector to the given constant.

Definition at line 1784 of file coefficient.cpp.

Member Data Documentation

◆ qf

QuadratureFunction* mfem::CoefficientVector::qf

protected

Internal QuadratureFunction (owned, may be NULL).

Definition at line 2322 of file coefficient.hpp.

◆ qs

QuadratureSpaceBase& mfem::CoefficientVector::qs

protected

Associated QuadratureSpaceBase.

Definition at line 2321 of file coefficient.hpp.

◆ storage

CoefficientStorage mfem::CoefficientVector::storage

protected

Storage optimizations (see CoefficientStorage).

Definition at line 2319 of file coefficient.hpp.

◆ vdim

int mfem::CoefficientVector::vdim

protected

Number of values per quadrature point.

Definition at line 2320 of file coefficient.hpp.

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

fem/coefficient.hpp
fem/coefficient.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CoefficientVector() [1/5]

◆ CoefficientVector() [2/5]

◆ CoefficientVector() [3/5]

◆ CoefficientVector() [4/5]

◆ CoefficientVector() [5/5]

◆ ~CoefficientVector()

Member Function Documentation

◆ GetVDim()

◆ MakeRef()

◆ Project() [1/3]

◆ Project() [2/3]

◆ Project() [3/3]

◆ ProjectTranspose()

◆ SetConstant() [1/4]

◆ SetConstant() [2/4]

◆ SetConstant() [3/4]

◆ SetConstant() [4/4]

Member Data Documentation

◆ qf

◆ qs

◆ storage

◆ vdim