 |
MFEM
v4.5.1
Finite element discretization library
|
|
MFEM
v4.5.1
Finite element discretization library
|
Class to represent a coefficient evaluated at quadrature points. More...
#include <coefficient.hpp>
Public Member Functions | |
| CoefficientVector (QuadratureSpaceBase &qs_, CoefficientStorage storage_=CoefficientStorage::FULL) | |
| Create an empty CoefficientVector. More... | |
| CoefficientVector (Coefficient *coeff, QuadratureSpaceBase &qs, CoefficientStorage storage_=CoefficientStorage::FULL) | |
| Create a CoefficientVector from the given Coefficient and QuadratureSpaceBase. More... | |
| CoefficientVector (Coefficient &coeff, QuadratureSpaceBase &qs, CoefficientStorage storage_=CoefficientStorage::FULL) | |
| Create a CoefficientVector from the given Coefficient and QuadratureSpaceBase. More... | |
| CoefficientVector (VectorCoefficient &coeff, QuadratureSpaceBase &qs, CoefficientStorage storage_=CoefficientStorage::FULL) | |
| Create a CoefficientVector from the given VectorCoefficient and QuadratureSpaceBase. More... | |
| CoefficientVector (MatrixCoefficient &coeff, QuadratureSpaceBase &qs, CoefficientStorage storage_=CoefficientStorage::FULL) | |
| Create a CoefficientVector from the given MatrixCoefficient and QuadratureSpaceBase. More... | |
| void | Project (Coefficient &coeff) |
| Evaluate the given Coefficient at the quadrature points defined by qs. More... | |
| void | Project (VectorCoefficient &coeff) |
| Evaluate the given VectorCoefficient at the quadrature points defined by qs. More... | |
| void | Project (MatrixCoefficient &coeff, bool transpose=false) |
| Evaluate the given MatrixCoefficient at the quadrature points defined by qs. More... | |
| void | ProjectTranspose (MatrixCoefficient &coeff) |
| Project the transpose of coeff. More... | |
| void | MakeRef (const QuadratureFunction &qf_) |
| Make this vector a reference to the given QuadratureFunction. More... | |
| void | SetConstant (double constant) |
| Set this vector to the given constant. More... | |
| void | SetConstant (const Vector &constant) |
| Set this vector to the given constant vector. More... | |
| void | SetConstant (const DenseMatrix &constant) |
| Set this vector to the given constant matrix. More... | |
| void | SetConstant (const DenseSymmetricMatrix &constant) |
| Set this vector to the given constant symmetric matrix. More... | |
| int | GetVDim () const |
| Return the number of values per quadrature point. More... | |
| ~CoefficientVector () | |
 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... | |
| 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= (Vector &&v) |
| Move 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 & | operator- (const Vector &v)=delete |
| operator- is not supported. Use subtract or Add. More... | |
| Vector & | operator+ (const Vector &v)=delete |
| operator+ is not supported. Use Add. More... | |
| 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 | 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... | |
| void | SetGlobalSeed (int gseed) |
| Set global seed for random values in sequential calls to Randomize(). 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... | |
Protected Attributes | |
| CoefficientStorage | storage |
| Storage optimizations (see CoefficientStorage). More... | |
| int | vdim |
| Number of values per quadrature point. More... | |
| QuadratureSpaceBase & | qs |
| Associated QuadratureSpaceBase. More... | |
| QuadratureFunction * | qf |
| Internal QuadratureFunction (owned, may be NULL). More... | |
| Protected Attributes inherited from mfem::Vector | |
| Memory< double > | data |
| int | size |
| bool | global_seed_set = false |
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 2185 of file coefficient.hpp.
| mfem::CoefficientVector::CoefficientVector | ( | QuadratureSpaceBase & | qs_, |
| CoefficientStorage | storage_ = CoefficientStorage::FULL |
||
| ) |
Create an empty CoefficientVector.
Definition at line 1588 of file coefficient.cpp.
| 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.
Definition at line 1595 of file coefficient.cpp.
| mfem::CoefficientVector::CoefficientVector | ( | Coefficient & | coeff, |
| QuadratureSpaceBase & | qs, | ||
| CoefficientStorage | storage_ = CoefficientStorage::FULL |
||
| ) |
Create a CoefficientVector from the given Coefficient and QuadratureSpaceBase.
Definition at line 1610 of file coefficient.cpp.
| mfem::CoefficientVector::CoefficientVector | ( | VectorCoefficient & | coeff, |
| QuadratureSpaceBase & | qs, | ||
| CoefficientStorage | storage_ = CoefficientStorage::FULL |
||
| ) |
Create a CoefficientVector from the given VectorCoefficient and QuadratureSpaceBase.
Definition at line 1618 of file coefficient.cpp.
| mfem::CoefficientVector::CoefficientVector | ( | MatrixCoefficient & | coeff, |
| QuadratureSpaceBase & | qs, | ||
| CoefficientStorage | storage_ = CoefficientStorage::FULL |
||
| ) |
Create a CoefficientVector from the given MatrixCoefficient and QuadratureSpaceBase.
Definition at line 1626 of file coefficient.cpp.
| mfem::CoefficientVector::~CoefficientVector | ( | ) |
Definition at line 1779 of file coefficient.cpp.
| int mfem::CoefficientVector::GetVDim | ( | ) | const |
Return the number of values per quadrature point.
Definition at line 1777 of file coefficient.cpp.
| void mfem::CoefficientVector::MakeRef | ( | const QuadratureFunction & | qf_ | ) |
Make this vector a reference to the given QuadratureFunction.
Definition at line 1707 of file coefficient.cpp.
| void mfem::CoefficientVector::Project | ( | Coefficient & | coeff | ) |
Evaluate the given Coefficient at the quadrature points defined by qs.
Definition at line 1634 of file coefficient.cpp.
| void mfem::CoefficientVector::Project | ( | VectorCoefficient & | coeff | ) |
Evaluate the given VectorCoefficient at the quadrature points defined by qs.
Definition at line 1654 of file coefficient.cpp.
| void mfem::CoefficientVector::Project | ( | MatrixCoefficient & | coeff, |
| bool | transpose = false |
||
| ) |
Evaluate the given MatrixCoefficient at the quadrature points defined by qs.
Definition at line 1675 of file coefficient.cpp.
| void mfem::CoefficientVector::ProjectTranspose | ( | MatrixCoefficient & | coeff | ) |
Project the transpose of coeff.
Definition at line 1702 of file coefficient.cpp.
| void mfem::CoefficientVector::SetConstant | ( | double | constant | ) |
Set this vector to the given constant.
Definition at line 1718 of file coefficient.cpp.
| void mfem::CoefficientVector::SetConstant | ( | const Vector & | constant | ) |
Set this vector to the given constant vector.
Definition at line 1726 of file coefficient.cpp.
| void mfem::CoefficientVector::SetConstant | ( | const DenseMatrix & | constant | ) |
Set this vector to the given constant matrix.
Definition at line 1740 of file coefficient.cpp.
| void mfem::CoefficientVector::SetConstant | ( | const DenseSymmetricMatrix & | constant | ) |
Set this vector to the given constant symmetric matrix.
Definition at line 1759 of file coefficient.cpp.
|
protected |
Internal QuadratureFunction (owned, may be NULL).
Definition at line 2191 of file coefficient.hpp.
|
protected |
Associated QuadratureSpaceBase.
Definition at line 2190 of file coefficient.hpp.
|
protected |
Storage optimizations (see CoefficientStorage).
Definition at line 2188 of file coefficient.hpp.
|
protected |
Number of values per quadrature point.
Definition at line 2189 of file coefficient.hpp.
1.8.5
