MFEM  v4.5.2
Finite element discretization library
Public Member Functions | Protected Attributes | List of all members
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:
[legend]
Collaboration diagram for mfem::QuadratureFunction:
[legend]

Public Member Functions

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

Protected Attributes

QuadratureSpaceBaseqspace
 Associated QuadratureSpaceBase object. More...
 
bool own_qspace
 Does this own the associated QuadratureSpaceBase? More...
 
int vdim
 Vector dimension. More...
 
- Protected Attributes inherited from mfem::Vector
Memory< double > 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 38 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 47 of file qfunction.hpp.

◆ QuadratureFunction() [4/6]

mfem::QuadratureFunction::QuadratureFunction ( QuadratureSpaceBase qspace_,
double *  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 57 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 63 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.

Definition at line 33 of file qfunction.cpp.

◆ ~QuadratureFunction()

virtual mfem::QuadratureFunction::~QuadratureFunction ( )
inlinevirtual

Definition at line 197 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 175 of file qfunction.hpp.

◆ GetSpace() [1/2]

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

Get the associated QuadratureSpaceBase object.

Definition at line 81 of file qfunction.hpp.

◆ GetSpace() [2/2]

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

Get the associated QuadratureSpaceBase object (const version).

Definition at line 84 of file qfunction.hpp.

◆ GetValues() [1/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 205 of file qfunction.hpp.

◆ GetValues() [2/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 213 of file qfunction.hpp.

◆ GetValues() [3/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 227 of file qfunction.hpp.

◆ GetValues() [4/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 234 of file qfunction.hpp.

◆ GetValues() [5/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 247 of file qfunction.hpp.

◆ GetValues() [6/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 259 of file qfunction.hpp.

◆ GetVDim()

int mfem::QuadratureFunction::GetVDim ( ) const
inline

Get the vector dimension.

Definition at line 74 of file qfunction.hpp.

◆ operator=() [1/2]

QuadratureFunction & mfem::QuadratureFunction::operator= ( double  value)

Set this equal to a constant value.

Definition at line 19 of file qfunction.cpp.

◆ operator=() [2/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().

Definition at line 25 of file qfunction.cpp.

◆ OwnsSpace()

bool mfem::QuadratureFunction::OwnsSpace ( )
inline

Get the QuadratureSpaceBase ownership flag.

Definition at line 111 of file qfunction.hpp.

◆ ProjectGridFunction()

void mfem::QuadratureFunction::ProjectGridFunction ( const GridFunction gf)

Evaluate a grid function at each quadrature point.

Definition at line 56 of file qfunction.cpp.

◆ Save()

void mfem::QuadratureFunction::Save ( std::ostream &  out) const

Write the QuadratureFunction to the stream out.

Definition at line 47 of file qfunction.cpp.

◆ SaveVTU() [1/2]

void mfem::QuadratureFunction::SaveVTU ( std::ostream &  out,
VTKFormat  format = VTKFormat::ASCII,
int  compression_level = 0 
) 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.

Definition at line 116 of file qfunction.cpp.

◆ SaveVTU() [2/2]

void mfem::QuadratureFunction::SaveVTU ( const std::string &  filename,
VTKFormat  format = VTKFormat::ASCII,
int  compression_level = 0 
) 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)

Definition at line 234 of file qfunction.cpp.

◆ SetOwnsSpace()

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

Set the QuadratureSpaceBase ownership flag.

Definition at line 114 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 277 of file qfunction.hpp.

◆ SetSpace() [2/2]

void mfem::QuadratureFunction::SetSpace ( QuadratureSpaceBase qspace_,
double *  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 290 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 77 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 files: