MFEM  v4.0
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mfem::GridFunction Class Reference

Class for grid function - Vector with associated FE space. More...

#include <gridfunc.hpp>

Inheritance diagram for mfem::GridFunction:
[legend]
Collaboration diagram for mfem::GridFunction:
[legend]

Public Types

enum  AvgType { ARITHMETIC, HARMONIC }
 

Public Member Functions

 GridFunction ()
 
 GridFunction (const GridFunction &orig)
 Copy constructor. The internal true-dof vector t_vec is not copied. More...
 
 GridFunction (FiniteElementSpace *f)
 Construct a GridFunction associated with the FiniteElementSpace *f. More...
 
 GridFunction (FiniteElementSpace *f, double *data)
 Construct a GridFunction using previously allocated array data. More...
 
 GridFunction (Mesh *m, std::istream &input)
 Construct a GridFunction on the given Mesh, using the data from input. More...
 
 GridFunction (Mesh *m, GridFunction *gf_array[], int num_pieces)
 
GridFunctionoperator= (const GridFunction &rhs)
 Copy assignment. Only the data of the base class Vector is copied. More...
 
void MakeOwner (FiniteElementCollection *_fec)
 Make the GridFunction the owner of fec and fes. More...
 
FiniteElementCollectionOwnFEC ()
 
int VectorDim () const
 
const VectorGetTrueVector () const
 Read only access to the (optional) internal true-dof Vector. More...
 
VectorGetTrueVector ()
 Read and write access to the (optional) internal true-dof Vector. More...
 
void GetTrueDofs (Vector &tv) const
 Extract the true-dofs from the GridFunction. If all dofs are true, then tv will be set to point to the data of *this. More...
 
void SetTrueVector ()
 Shortcut for calling GetTrueDofs() with GetTrueVector() as argument. More...
 
virtual void SetFromTrueDofs (const Vector &tv)
 Set the GridFunction from the given true-dof vector. More...
 
void SetFromTrueVector ()
 Shortcut for calling SetFromTrueDofs() with GetTrueVector() as argument. More...
 
void GetNodalValues (int i, Array< double > &nval, int vdim=1) const
 Returns the values in the vertices of i'th element for dimension vdim. More...
 
virtual double GetValue (int i, const IntegrationPoint &ip, int vdim=1) const
 
void GetVectorValue (int i, const IntegrationPoint &ip, Vector &val) const
 
void GetValues (int i, const IntegrationRule &ir, Vector &vals, int vdim=1) const
 
void GetValues (int i, const IntegrationRule &ir, Vector &vals, DenseMatrix &tr, int vdim=1) const
 
int GetFaceValues (int i, int side, const IntegrationRule &ir, Vector &vals, DenseMatrix &tr, int vdim=1) const
 
void GetVectorValues (ElementTransformation &T, const IntegrationRule &ir, DenseMatrix &vals) const
 
void GetVectorValues (int i, const IntegrationRule &ir, DenseMatrix &vals, DenseMatrix &tr) const
 
int GetFaceVectorValues (int i, int side, const IntegrationRule &ir, DenseMatrix &vals, DenseMatrix &tr) const
 
void GetValuesFrom (const GridFunction &orig_func)
 
void GetBdrValuesFrom (const GridFunction &orig_func)
 
void GetVectorFieldValues (int i, const IntegrationRule &ir, DenseMatrix &vals, DenseMatrix &tr, int comp=0) const
 
void ReorderByNodes ()
 For a vector grid function, makes sure that the ordering is byNODES. More...
 
void GetNodalValues (Vector &nval, int vdim=1) const
 Return the values as a vector on mesh vertices for dimension vdim. More...
 
void GetVectorFieldNodalValues (Vector &val, int comp) const
 
void ProjectVectorFieldOn (GridFunction &vec_field, int comp=0)
 
void GetDerivative (int comp, int der_comp, GridFunction &der)
 
double GetDivergence (ElementTransformation &tr) const
 
void GetCurl (ElementTransformation &tr, Vector &curl) const
 
void GetGradient (ElementTransformation &tr, Vector &grad) const
 
void GetGradients (ElementTransformation &tr, const IntegrationRule &ir, DenseMatrix &grad) const
 
void GetGradients (const int elem, const IntegrationRule &ir, DenseMatrix &grad) const
 
void GetVectorGradient (ElementTransformation &tr, DenseMatrix &grad) const
 
void GetElementAverages (GridFunction &avgs) const
 
void ImposeBounds (int i, const Vector &weights, const Vector &_lo, const Vector &_hi)
 
void ImposeBounds (int i, const Vector &weights, double _min=0.0, double _max=infinity())
 
void ProjectGridFunction (const GridFunction &src)
 Project the src GridFunction to this GridFunction, both of which must be on the same mesh. More...
 
virtual void ProjectCoefficient (Coefficient &coeff)
 
void ProjectCoefficient (Coefficient &coeff, Array< int > &dofs, int vd=0)
 
void ProjectCoefficient (VectorCoefficient &vcoeff)
 
void ProjectCoefficient (VectorCoefficient &vcoeff, Array< int > &dofs)
 
void ProjectCoefficient (Coefficient *coeff[])
 
virtual void ProjectDiscCoefficient (VectorCoefficient &coeff)
 Project a discontinuous vector coefficient as a grid function on a continuous finite element space. The values in shared dofs are determined from the element with maximal attribute. More...
 
virtual void ProjectDiscCoefficient (Coefficient &coeff, AvgType type)
 Projects a discontinuous coefficient so that the values in shared vdofs are computed by taking an average of the possible values. More...
 
virtual void ProjectDiscCoefficient (VectorCoefficient &coeff, AvgType type)
 Projects a discontinuous vector coefficient so that the values in shared vdofs are computed by taking an average of the possible values. More...
 
void ProjectBdrCoefficient (Coefficient &coeff, Array< int > &attr)
 Project a Coefficient on the GridFunction, modifying only DOFs on the boundary associated with the boundary attributes marked in the attr array. More...
 
virtual void ProjectBdrCoefficient (VectorCoefficient &vcoeff, Array< int > &attr)
 Project a VectorCoefficient on the GridFunction, modifying only DOFs on the boundary associated with the boundary attributes marked in the attr array. More...
 
virtual void ProjectBdrCoefficient (Coefficient *coeff[], Array< int > &attr)
 Project a set of Coefficients on the components of the GridFunction, modifying only DOFs on the boundary associated with the boundary attributed marked in the attr array. More...
 
void ProjectBdrCoefficientNormal (VectorCoefficient &vcoeff, Array< int > &bdr_attr)
 
virtual void ProjectBdrCoefficientTangent (VectorCoefficient &vcoeff, Array< int > &bdr_attr)
 Project the tangential components of the given VectorCoefficient on the boundary. Only boundary attributes that are marked in bdr_attr are projected. Assumes ND-type VectorFE GridFunction. More...
 
virtual double ComputeL2Error (Coefficient &exsol, const IntegrationRule *irs[]=NULL) const
 
virtual double ComputeL2Error (Coefficient *exsol[], const IntegrationRule *irs[]=NULL) const
 
virtual double ComputeL2Error (VectorCoefficient &exsol, const IntegrationRule *irs[]=NULL, Array< int > *elems=NULL) const
 
virtual double ComputeH1Error (Coefficient *exsol, VectorCoefficient *exgrad, Coefficient *ell_coef, double Nu, int norm_type) const
 
virtual double ComputeMaxError (Coefficient &exsol, const IntegrationRule *irs[]=NULL) const
 
virtual double ComputeMaxError (Coefficient *exsol[], const IntegrationRule *irs[]=NULL) const
 
virtual double ComputeMaxError (VectorCoefficient &exsol, const IntegrationRule *irs[]=NULL) const
 
virtual double ComputeL1Error (Coefficient &exsol, const IntegrationRule *irs[]=NULL) const
 
virtual double ComputeW11Error (Coefficient *exsol, VectorCoefficient *exgrad, int norm_type, Array< int > *elems=NULL, const IntegrationRule *irs[]=NULL) const
 
virtual double ComputeL1Error (VectorCoefficient &exsol, const IntegrationRule *irs[]=NULL) const
 
virtual double ComputeLpError (const double p, Coefficient &exsol, Coefficient *weight=NULL, const IntegrationRule *irs[]=NULL) const
 
virtual void ComputeElementLpErrors (const double p, Coefficient &exsol, GridFunction &error, Coefficient *weight=NULL, const IntegrationRule *irs[]=NULL) const
 
virtual void ComputeElementL1Errors (Coefficient &exsol, GridFunction &error, const IntegrationRule *irs[]=NULL) const
 
virtual void ComputeElementL2Errors (Coefficient &exsol, GridFunction &error, const IntegrationRule *irs[]=NULL) const
 
virtual void ComputeElementMaxErrors (Coefficient &exsol, GridFunction &error, const IntegrationRule *irs[]=NULL) const
 
virtual double ComputeLpError (const double p, VectorCoefficient &exsol, Coefficient *weight=NULL, VectorCoefficient *v_weight=NULL, const IntegrationRule *irs[]=NULL) const
 
virtual void ComputeElementLpErrors (const double p, VectorCoefficient &exsol, GridFunction &error, Coefficient *weight=NULL, VectorCoefficient *v_weight=NULL, const IntegrationRule *irs[]=NULL) const
 
virtual void ComputeElementL1Errors (VectorCoefficient &exsol, GridFunction &error, const IntegrationRule *irs[]=NULL) const
 
virtual void ComputeElementL2Errors (VectorCoefficient &exsol, GridFunction &error, const IntegrationRule *irs[]=NULL) const
 
virtual void ComputeElementMaxErrors (VectorCoefficient &exsol, GridFunction &error, const IntegrationRule *irs[]=NULL) const
 
virtual void ComputeFlux (BilinearFormIntegrator &blfi, GridFunction &flux, int wcoef=1, int subdomain=-1)
 
GridFunctionoperator= (double value)
 Redefine '=' for GridFunction = constant. More...
 
GridFunctionoperator= (const Vector &v)
 Copy the data from v. More...
 
virtual void Update ()
 Transform by the Space UpdateMatrix (e.g., on Mesh change). More...
 
FiniteElementSpaceFESpace ()
 
const FiniteElementSpaceFESpace () const
 
virtual void SetSpace (FiniteElementSpace *f)
 Associate a new FiniteElementSpace with the GridFunction. More...
 
virtual void MakeRef (FiniteElementSpace *f, double *v)
 Make the GridFunction reference external data on a new FiniteElementSpace. More...
 
virtual void MakeRef (FiniteElementSpace *f, Vector &v, int v_offset)
 Make the GridFunction reference external data on a new FiniteElementSpace. More...
 
void MakeTRef (FiniteElementSpace *f, double *tv)
 Associate a new FiniteElementSpace and new true-dof data with the GridFunction. More...
 
void MakeTRef (FiniteElementSpace *f, Vector &tv, int tv_offset)
 Associate a new FiniteElementSpace and new true-dof data with the GridFunction. More...
 
virtual void Save (std::ostream &out) const
 Save the GridFunction to an output stream. More...
 
void SaveVTK (std::ostream &out, const std::string &field_name, int ref)
 
void SaveSTL (std::ostream &out, int TimesToRefine=1)
 
virtual ~GridFunction ()
 Destroys grid function. 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...
 
void UseDevice (bool use_dev) const
 Enable execution of Vector operations using the mfem::Device. More...
 
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 MakeDataOwner () const
 Set the Vector data (host pointer) ownership flag. More...
 
void Destroy ()
 Destroy a vector. 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...
 
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)
 Update the memory location of the vector to match v. More...
 
void SyncAliasMemory (const Vector &v)
 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...
 
Vectoroperator= (const double *v)
 Copy Size() entries from v. More...
 
Vectoroperator= (const Vector &v)
 Copy assignment. More...
 
Vectoroperator= (double value)
 Redefine '=' for vector = constant. More...
 
Vectoroperator*= (double c)
 
Vectoroperator/= (double c)
 
Vectoroperator-= (double c)
 
Vectoroperator-= (const Vector &v)
 
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 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
 
void GetSubVector (const Array< int > &dofs, double *elem_data) const
 
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)
 
void SetSubVector (const Array< int > &dofs, double *elem_data)
 
void AddElementVector (const Array< int > &dofs, const Vector &elemvect)
 Add (element) subvector to the vector. More...
 
void AddElementVector (const Array< int > &dofs, double *elem_data)
 
void AddElementVector (const Array< int > &dofs, const double a, const Vector &elemvect)
 
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_HYPRE (std::ostream &out) const
 Prints vector to stream out in HYPRE_Vector format. 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...
 
const double * Read (bool on_dev=true) const
 Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), on_dev). More...
 
const double * HostRead () const
 Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), false). More...
 
double * Write (bool on_dev=true)
 Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), on_dev). More...
 
double * HostWrite ()
 Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), false). More...
 
double * ReadWrite (bool on_dev=true)
 Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), on_dev). More...
 
double * HostReadWrite ()
 Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), false). More...
 
 Vector (N_Vector nv)
 Construct a wrapper Vector from SUNDIALS N_Vector. More...
 
virtual N_Vector ToNVector ()
 Return a new wrapper SUNDIALS N_Vector of type SUNDIALS_NVEC_SERIAL. More...
 
virtual void ToNVector (N_Vector &nv)
 Update an existing wrapper SUNDIALS N_Vector to point to this Vector. More...
 

Protected Member Functions

void SaveSTLTri (std::ostream &out, double p1[], double p2[], double p3[])
 
void GetVectorGradientHat (ElementTransformation &T, DenseMatrix &gh) const
 
void ProjectDeltaCoefficient (DeltaCoefficient &delta_coeff, double &integral)
 
void SumFluxAndCount (BilinearFormIntegrator &blfi, GridFunction &flux, Array< int > &counts, int wcoef, int subdomain)
 
void ProjectDiscCoefficient (VectorCoefficient &coeff, Array< int > &dof_attr)
 
void Destroy ()
 
void AccumulateAndCountZones (Coefficient &coeff, AvgType type, Array< int > &zones_per_vdof)
 Accumulates (depending on type) the values of coeff at all shared vdofs and counts in how many zones each vdof appears. More...
 
void AccumulateAndCountZones (VectorCoefficient &vcoeff, AvgType type, Array< int > &zones_per_vdof)
 Accumulates (depending on type) the values of vcoeff at all shared vdofs and counts in how many zones each vdof appears. More...
 
void AccumulateAndCountBdrValues (Coefficient *coeff[], VectorCoefficient *vcoeff, Array< int > &attr, Array< int > &values_counter)
 
void AccumulateAndCountBdrTangentValues (VectorCoefficient &vcoeff, Array< int > &bdr_attr, Array< int > &values_counter)
 
void ComputeMeans (AvgType type, Array< int > &zones_per_vdof)
 

Protected Attributes

FiniteElementSpacefes
 FE space on which the grid function lives. Owned if fec is not NULL. More...
 
FiniteElementCollectionfec
 Used when the grid function is read from a file. It can also be set explicitly, see MakeOwner(). More...
 
long sequence
 
Vector t_vec
 
- Protected Attributes inherited from mfem::Vector
Memory< double > data
 
int size
 

Detailed Description

Class for grid function - Vector with associated FE space.

Definition at line 27 of file gridfunc.hpp.

Member Enumeration Documentation

Enumerator
ARITHMETIC 
HARMONIC 

Definition at line 239 of file gridfunc.hpp.

Constructor & Destructor Documentation

mfem::GridFunction::GridFunction ( )
inline

Definition at line 71 of file gridfunc.hpp.

mfem::GridFunction::GridFunction ( const GridFunction orig)
inline

Copy constructor. The internal true-dof vector t_vec is not copied.

Definition at line 74 of file gridfunc.hpp.

mfem::GridFunction::GridFunction ( FiniteElementSpace f)
inline

Construct a GridFunction associated with the FiniteElementSpace *f.

Definition at line 79 of file gridfunc.hpp.

mfem::GridFunction::GridFunction ( FiniteElementSpace f,
double *  data 
)
inline

Construct a GridFunction using previously allocated array data.

The GridFunction does not assume ownership of data which is assumed to be of size at least f->GetVSize(). Similar to the Vector constructor for externally allocated array, the pointer data can be NULL. The data array can be replaced later using the method SetData().

Definition at line 88 of file gridfunc.hpp.

mfem::GridFunction::GridFunction ( Mesh m,
std::istream &  input 
)

Construct a GridFunction on the given Mesh, using the data from input.

The content of input should be in the format created by the method Save(). The reconstructed FiniteElementSpace and FiniteElementCollection are owned by the GridFunction.

Definition at line 30 of file gridfunc.cpp.

mfem::GridFunction::GridFunction ( Mesh m,
GridFunction gf_array[],
int  num_pieces 
)

Definition at line 64 of file gridfunc.cpp.

virtual mfem::GridFunction::~GridFunction ( )
inlinevirtual

Destroys grid function.

Definition at line 483 of file gridfunc.hpp.

Member Function Documentation

void mfem::GridFunction::AccumulateAndCountBdrTangentValues ( VectorCoefficient vcoeff,
Array< int > &  bdr_attr,
Array< int > &  values_counter 
)
protected

Definition at line 1445 of file gridfunc.cpp.

void mfem::GridFunction::AccumulateAndCountBdrValues ( Coefficient coeff[],
VectorCoefficient vcoeff,
Array< int > &  attr,
Array< int > &  values_counter 
)
protected

Definition at line 1306 of file gridfunc.cpp.

void mfem::GridFunction::AccumulateAndCountZones ( Coefficient coeff,
AvgType  type,
Array< int > &  zones_per_vdof 
)
protected

Accumulates (depending on type) the values of coeff at all shared vdofs and counts in how many zones each vdof appears.

Definition at line 1216 of file gridfunc.cpp.

void mfem::GridFunction::AccumulateAndCountZones ( VectorCoefficient vcoeff,
AvgType  type,
Array< int > &  zones_per_vdof 
)
protected

Accumulates (depending on type) the values of vcoeff at all shared vdofs and counts in how many zones each vdof appears.

Definition at line 1254 of file gridfunc.cpp.

virtual void mfem::GridFunction::ComputeElementL1Errors ( Coefficient exsol,
GridFunction error,
const IntegrationRule irs[] = NULL 
) const
inlinevirtual

Definition at line 361 of file gridfunc.hpp.

virtual void mfem::GridFunction::ComputeElementL1Errors ( VectorCoefficient exsol,
GridFunction error,
const IntegrationRule irs[] = NULL 
) const
inlinevirtual

Definition at line 397 of file gridfunc.hpp.

virtual void mfem::GridFunction::ComputeElementL2Errors ( Coefficient exsol,
GridFunction error,
const IntegrationRule irs[] = NULL 
) const
inlinevirtual

Definition at line 367 of file gridfunc.hpp.

virtual void mfem::GridFunction::ComputeElementL2Errors ( VectorCoefficient exsol,
GridFunction error,
const IntegrationRule irs[] = NULL 
) const
inlinevirtual

Definition at line 403 of file gridfunc.hpp.

void mfem::GridFunction::ComputeElementLpErrors ( const double  p,
Coefficient exsol,
GridFunction error,
Coefficient weight = NULL,
const IntegrationRule irs[] = NULL 
) const
virtual

Compute the Lp error in each element of the mesh and store the results in the GridFunction error. The result should be an L2 GridFunction of order zero using map type VALUE.

Definition at line 2370 of file gridfunc.cpp.

void mfem::GridFunction::ComputeElementLpErrors ( const double  p,
VectorCoefficient exsol,
GridFunction error,
Coefficient weight = NULL,
VectorCoefficient v_weight = NULL,
const IntegrationRule irs[] = NULL 
) const
virtual

Compute the Lp error in each element of the mesh and store the results in the GridFunction @ error. The result should be an L2 GridFunction of order zero using map type VALUE.

Definition at line 2524 of file gridfunc.cpp.

virtual void mfem::GridFunction::ComputeElementMaxErrors ( Coefficient exsol,
GridFunction error,
const IntegrationRule irs[] = NULL 
) const
inlinevirtual

Definition at line 373 of file gridfunc.hpp.

virtual void mfem::GridFunction::ComputeElementMaxErrors ( VectorCoefficient exsol,
GridFunction error,
const IntegrationRule irs[] = NULL 
) const
inlinevirtual

Definition at line 409 of file gridfunc.hpp.

void mfem::GridFunction::ComputeFlux ( BilinearFormIntegrator blfi,
GridFunction flux,
int  wcoef = 1,
int  subdomain = -1 
)
virtual

Reimplemented in mfem::ParGridFunction.

Definition at line 287 of file gridfunc.cpp.

double mfem::GridFunction::ComputeH1Error ( Coefficient exsol,
VectorCoefficient exgrad,
Coefficient ell_coef,
double  Nu,
int  norm_type 
) const
virtual

Definition at line 1994 of file gridfunc.cpp.

virtual double mfem::GridFunction::ComputeL1Error ( Coefficient exsol,
const IntegrationRule irs[] = NULL 
) const
inlinevirtual

Reimplemented in mfem::ParGridFunction.

Definition at line 336 of file gridfunc.hpp.

virtual double mfem::GridFunction::ComputeL1Error ( VectorCoefficient exsol,
const IntegrationRule irs[] = NULL 
) const
inlinevirtual

Reimplemented in mfem::ParGridFunction.

Definition at line 344 of file gridfunc.hpp.

virtual double mfem::GridFunction::ComputeL2Error ( Coefficient exsol,
const IntegrationRule irs[] = NULL 
) const
inlinevirtual

Reimplemented in mfem::ParGridFunction.

Definition at line 306 of file gridfunc.hpp.

double mfem::GridFunction::ComputeL2Error ( Coefficient exsol[],
const IntegrationRule irs[] = NULL 
) const
virtual

Reimplemented in mfem::ParGridFunction.

Definition at line 1892 of file gridfunc.cpp.

double mfem::GridFunction::ComputeL2Error ( VectorCoefficient exsol,
const IntegrationRule irs[] = NULL,
Array< int > *  elems = NULL 
) const
virtual

Reimplemented in mfem::ParGridFunction.

Definition at line 1949 of file gridfunc.cpp.

double mfem::GridFunction::ComputeLpError ( const double  p,
Coefficient exsol,
Coefficient weight = NULL,
const IntegrationRule irs[] = NULL 
) const
virtual

Reimplemented in mfem::ParGridFunction.

Definition at line 2305 of file gridfunc.cpp.

double mfem::GridFunction::ComputeLpError ( const double  p,
VectorCoefficient exsol,
Coefficient weight = NULL,
VectorCoefficient v_weight = NULL,
const IntegrationRule irs[] = NULL 
) const
virtual

When given a vector weight, compute the pointwise (scalar) error as the dot product of the vector error with the vector weight. Otherwise, the scalar error is the l_2 norm of the vector error.

Reimplemented in mfem::ParGridFunction.

Definition at line 2433 of file gridfunc.cpp.

virtual double mfem::GridFunction::ComputeMaxError ( Coefficient exsol,
const IntegrationRule irs[] = NULL 
) const
inlinevirtual

Reimplemented in mfem::ParGridFunction.

Definition at line 321 of file gridfunc.hpp.

double mfem::GridFunction::ComputeMaxError ( Coefficient exsol[],
const IntegrationRule irs[] = NULL 
) const
virtual

Reimplemented in mfem::ParGridFunction.

Definition at line 2142 of file gridfunc.cpp.

virtual double mfem::GridFunction::ComputeMaxError ( VectorCoefficient exsol,
const IntegrationRule irs[] = NULL 
) const
inlinevirtual

Reimplemented in mfem::ParGridFunction.

Definition at line 330 of file gridfunc.hpp.

void mfem::GridFunction::ComputeMeans ( AvgType  type,
Array< int > &  zones_per_vdof 
)
protected

Definition at line 1494 of file gridfunc.cpp.

double mfem::GridFunction::ComputeW11Error ( Coefficient exsol,
VectorCoefficient exgrad,
int  norm_type,
Array< int > *  elems = NULL,
const IntegrationRule irs[] = NULL 
) const
virtual

Definition at line 2199 of file gridfunc.cpp.

void mfem::GridFunction::Destroy ( )
protected

Definition at line 142 of file gridfunc.cpp.

FiniteElementSpace* mfem::GridFunction::FESpace ( )
inline

Definition at line 430 of file gridfunc.hpp.

const FiniteElementSpace* mfem::GridFunction::FESpace ( ) const
inline

Definition at line 431 of file gridfunc.hpp.

void mfem::GridFunction::GetBdrValuesFrom ( const GridFunction orig_func)

Definition at line 662 of file gridfunc.cpp.

void mfem::GridFunction::GetCurl ( ElementTransformation tr,
Vector curl 
) const

Definition at line 952 of file gridfunc.cpp.

void mfem::GridFunction::GetDerivative ( int  comp,
int  der_comp,
GridFunction der 
)

Definition at line 839 of file gridfunc.cpp.

double mfem::GridFunction::GetDivergence ( ElementTransformation tr) const

Definition at line 918 of file gridfunc.cpp.

void mfem::GridFunction::GetElementAverages ( GridFunction avgs) const

Compute \( (\int_{\Omega} (*this) \psi_i)/(\int_{\Omega} \psi_i) \), where \( \psi_i \) are the basis functions for the FE space of avgs. Both FE spaces should be scalar and on the same mesh.

Definition at line 1058 of file gridfunc.cpp.

int mfem::GridFunction::GetFaceValues ( int  i,
int  side,
const IntegrationRule ir,
Vector vals,
DenseMatrix tr,
int  vdim = 1 
) const

Definition at line 478 of file gridfunc.cpp.

int mfem::GridFunction::GetFaceVectorValues ( int  i,
int  side,
const IntegrationRule ir,
DenseMatrix vals,
DenseMatrix tr 
) const

Definition at line 582 of file gridfunc.cpp.

void mfem::GridFunction::GetGradient ( ElementTransformation tr,
Vector grad 
) const

Definition at line 1003 of file gridfunc.cpp.

void mfem::GridFunction::GetGradients ( ElementTransformation tr,
const IntegrationRule ir,
DenseMatrix grad 
) const

Definition at line 1021 of file gridfunc.cpp.

void mfem::GridFunction::GetGradients ( const int  elem,
const IntegrationRule ir,
DenseMatrix grad 
) const
inline

Definition at line 196 of file gridfunc.hpp.

void mfem::GridFunction::GetNodalValues ( int  i,
Array< double > &  nval,
int  vdim = 1 
) const

Returns the values in the vertices of i'th element for dimension vdim.

Definition at line 355 of file gridfunc.cpp.

void mfem::GridFunction::GetNodalValues ( Vector nval,
int  vdim = 1 
) const

Return the values as a vector on mesh vertices for dimension vdim.

Definition at line 1190 of file gridfunc.cpp.

void mfem::GridFunction::GetTrueDofs ( Vector tv) const

Extract the true-dofs from the GridFunction. If all dofs are true, then tv will be set to point to the data of *this.

Warning
This method breaks const-ness when all dofs are true.

Definition at line 323 of file gridfunc.cpp.

const Vector& mfem::GridFunction::GetTrueVector ( ) const
inline

Read only access to the (optional) internal true-dof Vector.

Note that the returned Vector may be empty, if not previously allocated or set.

Definition at line 121 of file gridfunc.hpp.

Vector& mfem::GridFunction::GetTrueVector ( )
inline

Read and write access to the (optional) internal true-dof Vector.

Note that the returned Vector may be empty, if not previously allocated or set.

Definition at line 125 of file gridfunc.hpp.

double mfem::GridFunction::GetValue ( int  i,
const IntegrationPoint ip,
int  vdim = 1 
) const
virtual

Reimplemented in mfem::ParGridFunction.

Definition at line 396 of file gridfunc.cpp.

void mfem::GridFunction::GetValues ( int  i,
const IntegrationRule ir,
Vector vals,
int  vdim = 1 
) const

Definition at line 445 of file gridfunc.cpp.

void mfem::GridFunction::GetValues ( int  i,
const IntegrationRule ir,
Vector vals,
DenseMatrix tr,
int  vdim = 1 
) const

Definition at line 467 of file gridfunc.cpp.

void mfem::GridFunction::GetValuesFrom ( const GridFunction orig_func)

Definition at line 625 of file gridfunc.cpp.

void mfem::GridFunction::GetVectorFieldNodalValues ( Vector val,
int  comp 
) const

Definition at line 768 of file gridfunc.cpp.

void mfem::GridFunction::GetVectorFieldValues ( int  i,
const IntegrationRule ir,
DenseMatrix vals,
DenseMatrix tr,
int  comp = 0 
) const

Definition at line 699 of file gridfunc.cpp.

void mfem::GridFunction::GetVectorGradient ( ElementTransformation tr,
DenseMatrix grad 
) const

Definition at line 1046 of file gridfunc.cpp.

void mfem::GridFunction::GetVectorGradientHat ( ElementTransformation T,
DenseMatrix gh 
) const
protected

Definition at line 899 of file gridfunc.cpp.

void mfem::GridFunction::GetVectorValue ( int  i,
const IntegrationPoint ip,
Vector val 
) const

Definition at line 411 of file gridfunc.cpp.

void mfem::GridFunction::GetVectorValues ( ElementTransformation T,
const IntegrationRule ir,
DenseMatrix vals 
) const

Definition at line 528 of file gridfunc.cpp.

void mfem::GridFunction::GetVectorValues ( int  i,
const IntegrationRule ir,
DenseMatrix vals,
DenseMatrix tr 
) const

Definition at line 573 of file gridfunc.cpp.

void mfem::GridFunction::ImposeBounds ( int  i,
const Vector weights,
const Vector _lo,
const Vector _hi 
)

Impose the given bounds on the function's DOFs while preserving its local integral (described in terms of the given weights) on the i'th element through SLBPQ optimization. Intended to be used for discontinuous FE functions.

Definition at line 1132 of file gridfunc.cpp.

void mfem::GridFunction::ImposeBounds ( int  i,
const Vector weights,
double  _min = 0.0,
double  _max = infinity() 
)

Definition at line 1159 of file gridfunc.cpp.

void mfem::GridFunction::MakeOwner ( FiniteElementCollection _fec)
inline

Make the GridFunction the owner of fec and fes.

If the new FiniteElementCollection, _fec, is NULL, ownership of fec and fes is taken away.

Definition at line 112 of file gridfunc.hpp.

void mfem::GridFunction::MakeRef ( FiniteElementSpace f,
double *  v 
)
virtual

Make the GridFunction reference external data on a new FiniteElementSpace.

This method changes the FiniteElementSpace associated with the GridFunction and sets the pointer v as external data in the GridFunction.

Reimplemented in mfem::ParGridFunction.

Definition at line 188 of file gridfunc.cpp.

void mfem::GridFunction::MakeRef ( FiniteElementSpace f,
Vector v,
int  v_offset 
)
virtual

Make the GridFunction reference external data on a new FiniteElementSpace.

This method changes the FiniteElementSpace associated with the GridFunction and sets the data of the Vector v (plus the v_offset) as external data in the GridFunction.

Note
This version of the method will also perform bounds checks when the build option MFEM_DEBUG is enabled.

Reimplemented in mfem::ParGridFunction.

Definition at line 196 of file gridfunc.cpp.

void mfem::GridFunction::MakeTRef ( FiniteElementSpace f,
double *  tv 
)

Associate a new FiniteElementSpace and new true-dof data with the GridFunction.

Definition at line 207 of file gridfunc.cpp.

void mfem::GridFunction::MakeTRef ( FiniteElementSpace f,
Vector tv,
int  tv_offset 
)

Associate a new FiniteElementSpace and new true-dof data with the GridFunction.

  • If the prolongation matrix of f is trivial (i.e. its method FiniteElementSpace::GetProlongationMatrix() returns NULL), this method calls MakeRef() with the same arguments.
  • Otherwise, this method calls SetSpace() with argument f.
  • The internal true-dof vector is set to reference the sub-vector of tv starting at the offset tv_offset.

Definition at line 221 of file gridfunc.cpp.

GridFunction& mfem::GridFunction::operator= ( const GridFunction rhs)
inline

Copy assignment. Only the data of the base class Vector is copied.

It is assumed that this object and rhs use FiniteElementSpaces that have the same size.

Note
Defining this method overwrites the implicitly defined copy assignemnt operator.

Definition at line 106 of file gridfunc.hpp.

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

Redefine '=' for GridFunction = constant.

Definition at line 2614 of file gridfunc.cpp.

GridFunction & mfem::GridFunction::operator= ( const Vector v)

Copy the data from v.

The size of v must be equal to the size of the associated FiniteElementSpace fes.

Definition at line 2620 of file gridfunc.cpp.

FiniteElementCollection* mfem::GridFunction::OwnFEC ( )
inline

Definition at line 114 of file gridfunc.hpp.

void mfem::GridFunction::ProjectBdrCoefficient ( Coefficient coeff,
Array< int > &  attr 
)
inline

Project a Coefficient on the GridFunction, modifying only DOFs on the boundary associated with the boundary attributes marked in the attr array.

Definition at line 275 of file gridfunc.hpp.

void mfem::GridFunction::ProjectBdrCoefficient ( VectorCoefficient vcoeff,
Array< int > &  attr 
)
virtual

Project a VectorCoefficient on the GridFunction, modifying only DOFs on the boundary associated with the boundary attributes marked in the attr array.

Reimplemented in mfem::ParGridFunction.

Definition at line 1770 of file gridfunc.cpp.

void mfem::GridFunction::ProjectBdrCoefficient ( Coefficient coeff[],
Array< int > &  attr 
)
virtual

Project a set of Coefficients on the components of the GridFunction, modifying only DOFs on the boundary associated with the boundary attributed marked in the attr array.

If a Coefficient pointer in the array coeff is NULL, that component will not be touched.

Reimplemented in mfem::ParGridFunction.

Definition at line 1787 of file gridfunc.cpp.

void mfem::GridFunction::ProjectBdrCoefficientNormal ( VectorCoefficient vcoeff,
Array< int > &  bdr_attr 
)

Project the normal component of the given VectorCoefficient on the boundary. Only boundary attributes that are marked in 'bdr_attr' are projected. Assumes RT-type VectorFE GridFunction.

Definition at line 1804 of file gridfunc.cpp.

void mfem::GridFunction::ProjectBdrCoefficientTangent ( VectorCoefficient vcoeff,
Array< int > &  bdr_attr 
)
virtual

Project the tangential components of the given VectorCoefficient on the boundary. Only boundary attributes that are marked in bdr_attr are projected. Assumes ND-type VectorFE GridFunction.

Reimplemented in mfem::ParGridFunction.

Definition at line 1875 of file gridfunc.cpp.

void mfem::GridFunction::ProjectCoefficient ( Coefficient coeff)
virtual

Reimplemented in mfem::ParGridFunction.

Definition at line 1582 of file gridfunc.cpp.

void mfem::GridFunction::ProjectCoefficient ( Coefficient coeff,
Array< int > &  dofs,
int  vd = 0 
)

Definition at line 1609 of file gridfunc.cpp.

void mfem::GridFunction::ProjectCoefficient ( VectorCoefficient vcoeff)

Definition at line 1633 of file gridfunc.cpp.

void mfem::GridFunction::ProjectCoefficient ( VectorCoefficient vcoeff,
Array< int > &  dofs 
)

Definition at line 1648 of file gridfunc.cpp.

void mfem::GridFunction::ProjectCoefficient ( Coefficient coeff[])

Definition at line 1678 of file gridfunc.cpp.

void mfem::GridFunction::ProjectDeltaCoefficient ( DeltaCoefficient delta_coeff,
double &  integral 
)
protected

Definition at line 1519 of file gridfunc.cpp.

void mfem::GridFunction::ProjectDiscCoefficient ( VectorCoefficient coeff,
Array< int > &  dof_attr 
)
protected

Project a discontinuous vector coefficient in a continuous space and return in dof_attr the maximal attribute of the elements containing each degree of freedom.

Definition at line 1713 of file gridfunc.cpp.

void mfem::GridFunction::ProjectDiscCoefficient ( VectorCoefficient coeff)
virtual

Project a discontinuous vector coefficient as a grid function on a continuous finite element space. The values in shared dofs are determined from the element with maximal attribute.

Reimplemented in mfem::ParGridFunction.

Definition at line 1744 of file gridfunc.cpp.

void mfem::GridFunction::ProjectDiscCoefficient ( Coefficient coeff,
AvgType  type 
)
virtual

Projects a discontinuous coefficient so that the values in shared vdofs are computed by taking an average of the possible values.

Reimplemented in mfem::ParGridFunction.

Definition at line 1750 of file gridfunc.cpp.

void mfem::GridFunction::ProjectDiscCoefficient ( VectorCoefficient coeff,
AvgType  type 
)
virtual

Projects a discontinuous vector coefficient so that the values in shared vdofs are computed by taking an average of the possible values.

Reimplemented in mfem::ParGridFunction.

Definition at line 1761 of file gridfunc.cpp.

void mfem::GridFunction::ProjectGridFunction ( const GridFunction src)

Project the src GridFunction to this GridFunction, both of which must be on the same mesh.

The current implementation assumes that all elements use the same projection matrix.

Definition at line 1088 of file gridfunc.cpp.

void mfem::GridFunction::ProjectVectorFieldOn ( GridFunction vec_field,
int  comp = 0 
)

Definition at line 799 of file gridfunc.cpp.

void mfem::GridFunction::ReorderByNodes ( )

For a vector grid function, makes sure that the ordering is byNODES.

Definition at line 741 of file gridfunc.cpp.

void mfem::GridFunction::Save ( std::ostream &  out) const
virtual

Save the GridFunction to an output stream.

Reimplemented in mfem::ParGridFunction.

Definition at line 2627 of file gridfunc.cpp.

void mfem::GridFunction::SaveSTL ( std::ostream &  out,
int  TimesToRefine = 1 
)

Definition at line 2749 of file gridfunc.cpp.

void mfem::GridFunction::SaveSTLTri ( std::ostream &  out,
double  p1[],
double  p2[],
double  p3[] 
)
protected

Definition at line 2729 of file gridfunc.cpp.

void mfem::GridFunction::SaveVTK ( std::ostream &  out,
const std::string &  field_name,
int  ref 
)

Write the GridFunction in VTK format. Note that Mesh::PrintVTK must be called first. The parameter ref > 0 must match the one used in Mesh::PrintVTK.

Definition at line 2652 of file gridfunc.cpp.

void mfem::GridFunction::SetFromTrueDofs ( const Vector tv)
virtual

Set the GridFunction from the given true-dof vector.

Reimplemented in mfem::ParGridFunction.

Definition at line 338 of file gridfunc.cpp.

void mfem::GridFunction::SetFromTrueVector ( )
inline

Shortcut for calling SetFromTrueDofs() with GetTrueVector() as argument.

Definition at line 139 of file gridfunc.hpp.

void mfem::GridFunction::SetSpace ( FiniteElementSpace f)
virtual

Associate a new FiniteElementSpace with the GridFunction.

The GridFunction is resized using the SetSize() method.

Reimplemented in mfem::ParGridFunction.

Definition at line 180 of file gridfunc.cpp.

void mfem::GridFunction::SetTrueVector ( )
inline

Shortcut for calling GetTrueDofs() with GetTrueVector() as argument.

Definition at line 133 of file gridfunc.hpp.

void mfem::GridFunction::SumFluxAndCount ( BilinearFormIntegrator blfi,
GridFunction flux,
Array< int > &  counts,
int  wcoef,
int  subdomain 
)
protected

Definition at line 240 of file gridfunc.cpp.

void mfem::GridFunction::Update ( )
virtual

Transform by the Space UpdateMatrix (e.g., on Mesh change).

Reimplemented in mfem::ParGridFunction.

Definition at line 152 of file gridfunc.cpp.

int mfem::GridFunction::VectorDim ( ) const

Definition at line 302 of file gridfunc.cpp.

Member Data Documentation

FiniteElementCollection* mfem::GridFunction::fec
protected

Used when the grid function is read from a file. It can also be set explicitly, see MakeOwner().

If not NULL, this pointer is owned by the GridFunction.

Definition at line 37 of file gridfunc.hpp.

FiniteElementSpace* mfem::GridFunction::fes
protected

FE space on which the grid function lives. Owned if fec is not NULL.

Definition at line 31 of file gridfunc.hpp.

long mfem::GridFunction::sequence
protected

Definition at line 39 of file gridfunc.hpp.

Vector mfem::GridFunction::t_vec
protected

Optional, internal true-dof vector: if the FiniteElementSpace fes has a non-trivial (i.e. not NULL) prolongation operator, this Vector may hold associated true-dof values - either owned or external.

Definition at line 44 of file gridfunc.hpp.


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