MFEM
v4.3.0
Finite element discretization library
|
Class representing a function through its values (scalar or vector) at quadrature points. More...
#include <gridfunc.hpp>
Public Member Functions | |
QuadratureFunction () | |
Create an empty QuadratureFunction. More... | |
QuadratureFunction (const QuadratureFunction &orig) | |
Copy constructor. The QuadratureSpace ownership flag, own_qspace, in the new object is set to false. More... | |
QuadratureFunction (QuadratureSpace *qspace_, int vdim_=1) | |
Create a QuadratureFunction based on the given QuadratureSpace. More... | |
QuadratureFunction (QuadratureSpace *qspace_, double *qf_data, int vdim_=1) | |
Create a QuadratureFunction based on the given QuadratureSpace, using the external data, qf_data. More... | |
QuadratureFunction (Mesh *mesh, std::istream &in) | |
Read a QuadratureFunction from the stream in. More... | |
virtual | ~QuadratureFunction () |
QuadratureSpace * | GetSpace () const |
Get the associated QuadratureSpace. More... | |
void | SetSpace (QuadratureSpace *qspace_, int vdim_=-1) |
Change the QuadratureSpace and optionally the vector dimension. More... | |
void | SetSpace (QuadratureSpace *qspace_, double *qf_data, int vdim_=-1) |
Change the QuadratureSpace, the data array, and optionally the vector dimension. 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... | |
bool | OwnsSpace () |
Get the QuadratureSpace ownership flag. More... | |
void | SetOwnsSpace (bool own) |
Set the QuadratureSpace ownership flag. More... | |
QuadratureFunction & | operator= (double value) |
Redefine '=' for QuadratureFunction = constant. More... | |
QuadratureFunction & | operator= (const Vector &v) |
Copy the data from v. More... | |
QuadratureFunction & | operator= (const QuadratureFunction &v) |
Copy assignment. Only the data of the base class Vector is copied. More... | |
const IntegrationRule & | GetElementIntRule (int idx) const |
Get the IntegrationRule associated with mesh element idx. More... | |
void | GetElementValues (int idx, Vector &values) |
Return all values associated with mesh element idx in a Vector. More... | |
void | GetElementValues (int idx, Vector &values) const |
Return all values associated with mesh element idx in a Vector. More... | |
void | GetElementValues (int idx, const int ip_num, Vector &values) |
Return the quadrature function values at an integration point. More... | |
void | GetElementValues (int idx, const int ip_num, Vector &values) const |
Return the quadrature function values at an integration point. More... | |
void | GetElementValues (int idx, DenseMatrix &values) |
Return all values associated with mesh element idx in a DenseMatrix. More... | |
void | GetElementValues (int idx, DenseMatrix &values) const |
Return all values associated with mesh element idx in a const DenseMatrix. More... | |
void | Save (std::ostream &out) const |
Write the QuadratureFunction to the stream out. More... | |
Public Member Functions inherited from mfem::Vector | |
Vector () | |
Default constructor for Vector. Sets size = 0 and data = NULL. More... | |
Vector (const Vector &) | |
Copy constructor. Allocates a new data array and copies the data. 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 (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... | |
operator double * () | |
Conversion to double * . More... | |
operator const double * () const | |
Conversion to const double * . 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* (const double *) const |
Dot product with a double * array. More... | |
double | operator* (const Vector &v) const |
Return the inner-product. More... | |
Vector & | operator= (const double *v) |
Copy Size() entries from v. More... | |
Vector & | operator= (const Vector &v) |
Copy assignment. More... | |
Vector & | operator= (double value) |
Redefine '=' for vector = constant. More... | |
Vector & | operator*= (double c) |
Vector & | operator*= (const Vector &v) |
Component-wise scaling: (*this)(i) *= v(i) More... | |
Vector & | operator/= (double c) |
Vector & | operator/= (const Vector &v) |
Component-wise division: (*this)(i) /= v(i) More... | |
Vector & | operator-= (double c) |
Vector & | operator-= (const Vector &v) |
Vector & | operator+= (double c) |
Vector & | operator+= (const Vector &v) |
Vector & | Add (const double a, const Vector &Va) |
(*this) += a * Va More... | |
Vector & | Set (const double a, const Vector &x) |
(*this) = a * x More... | |
void | SetVector (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 | DistanceTo (const double *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... | |
MFEM_DEPRECATED | Vector (N_Vector nv) |
(DEPRECATED) Construct a wrapper Vector from SUNDIALS N_Vector. More... | |
virtual MFEM_DEPRECATED N_Vector | ToNVector () |
(DEPRECATED) Return a new wrapper SUNDIALS N_Vector of type SUNDIALS_NVEC_SERIAL. More... | |
virtual MFEM_DEPRECATED void | ToNVector (N_Vector &nv, long global_length=0) |
Update an existing wrapper SUNDIALS N_Vector to point to this Vector. More... | |
Protected Attributes | |
QuadratureSpace * | qspace |
Associated QuadratureSpace. More... | |
int | vdim |
Vector dimension. More... | |
bool | own_qspace |
QuadratureSpace ownership flag. More... | |
Protected Attributes inherited from mfem::Vector | |
Memory< double > | data |
int | size |
Class representing a function through its values (scalar or vector) at quadrature points.
Definition at line 734 of file gridfunc.hpp.
|
inline |
Create an empty QuadratureFunction.
The object can be initialized later using the SetSpace() methods.
Definition at line 744 of file gridfunc.hpp.
|
inline |
Copy constructor. The QuadratureSpace ownership flag, own_qspace, in the new object is set to false.
Definition at line 749 of file gridfunc.hpp.
|
inline |
Create a QuadratureFunction based on the given QuadratureSpace.
The QuadratureFunction does not assume ownership of the QuadratureSpace.
Definition at line 756 of file gridfunc.hpp.
|
inline |
Create a QuadratureFunction based on the given QuadratureSpace, using the external data, qf_data.
The QuadratureFunction does not assume ownership of neither the QuadratureSpace nor the external data.
Definition at line 764 of file gridfunc.hpp.
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 3787 of file gridfunc.cpp.
|
inlinevirtual |
Definition at line 772 of file gridfunc.hpp.
|
inline |
Get the IntegrationRule associated with mesh element idx.
Definition at line 832 of file gridfunc.hpp.
|
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 948 of file gridfunc.hpp.
|
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 955 of file gridfunc.hpp.
|
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 967 of file gridfunc.hpp.
|
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 974 of file gridfunc.hpp.
|
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 986 of file gridfunc.hpp.
|
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 993 of file gridfunc.hpp.
|
inline |
Get the associated QuadratureSpace.
Definition at line 775 of file gridfunc.hpp.
|
inline |
Get the vector dimension.
Definition at line 802 of file gridfunc.hpp.
QuadratureFunction & mfem::QuadratureFunction::operator= | ( | double | value | ) |
Redefine '=' for QuadratureFunction = constant.
Definition at line 3801 of file gridfunc.cpp.
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 QuadratureSpace qspace times the QuadratureFunction dimension i.e. QuadratureFunction::Size().
Definition at line 3807 of file gridfunc.cpp.
QuadratureFunction & mfem::QuadratureFunction::operator= | ( | const QuadratureFunction & | v | ) |
Copy assignment. Only the data of the base class Vector is copied.
The QuadratureFunctions v and *this must have QuadratureSpaces with the same size.
Definition at line 3814 of file gridfunc.cpp.
|
inline |
Get the QuadratureSpace ownership flag.
Definition at line 809 of file gridfunc.hpp.
void mfem::QuadratureFunction::Save | ( | std::ostream & | out | ) | const |
Write the QuadratureFunction to the stream out.
Definition at line 3819 of file gridfunc.cpp.
|
inline |
Set the QuadratureSpace ownership flag.
Definition at line 812 of file gridfunc.hpp.
|
inline |
Change the QuadratureSpace and optionally the vector dimension.
If the new QuadratureSpace 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 923 of file gridfunc.hpp.
|
inline |
Change the QuadratureSpace, the data array, and optionally the vector dimension.
If the new QuadratureSpace 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 935 of file gridfunc.hpp.
|
inline |
Set the vector dimension, updating the size by calling Vector::SetSize().
Definition at line 805 of file gridfunc.hpp.
|
protected |
QuadratureSpace ownership flag.
Definition at line 739 of file gridfunc.hpp.
|
protected |
Associated QuadratureSpace.
Definition at line 737 of file gridfunc.hpp.
|
protected |
Vector dimension.
Definition at line 738 of file gridfunc.hpp.