MFEM  v3.4
Finite element discretization library
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. 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)
 
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 (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)
 
void ProjectBdrCoefficient (Coefficient *coeff[], Array< int > &attr)
 
void ProjectBdrCoefficientNormal (VectorCoefficient &vcoeff, Array< int > &bdr_attr)
 
void ProjectBdrCoefficientTangent (VectorCoefficient &vcoeff, Array< int > &bdr_attr)
 
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 double ComputeLpError (const double p, VectorCoefficient &exsol, Coefficient *weight=NULL, VectorCoefficient *v_weight=NULL, 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...
 
GridFunctionoperator= (const GridFunction &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...
 
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 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 MakeDataOwner ()
 
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...
 
bool OwnsData () const
 
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)
 Redefine '=' for vector = vector. 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
 
virtual ~Vector ()
 Destroys vector. 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 ComputeMeans (AvgType type, Array< int > &zones_per_vdof)
 

Protected Attributes

FiniteElementSpacefes
 FE space on which grid function lives. More...
 
FiniteElementCollectionfec
 Used when the grid function is read from a file. More...
 
long sequence
 
Vector t_vec
 
- Protected Attributes inherited from mfem::Vector
int size
 
int allocsize
 
double * data
 

Detailed Description

Class for grid function - Vector with associated FE space.

Definition at line 27 of file gridfunc.hpp.

Member Enumeration Documentation

◆ AvgType

Enumerator
ARITHMETIC 
HARMONIC 

Definition at line 218 of file gridfunc.hpp.

Constructor & Destructor Documentation

◆ GridFunction() [1/6]

mfem::GridFunction::GridFunction ( )
inline

Definition at line 68 of file gridfunc.hpp.

◆ GridFunction() [2/6]

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

Copy constructor.

Definition at line 71 of file gridfunc.hpp.

◆ GridFunction() [3/6]

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

Construct a GridFunction associated with the FiniteElementSpace *f.

Definition at line 75 of file gridfunc.hpp.

◆ GridFunction() [4/6]

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 84 of file gridfunc.hpp.

◆ GridFunction() [5/6]

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.

◆ GridFunction() [6/6]

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

Definition at line 61 of file gridfunc.cpp.

◆ ~GridFunction()

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

Destroys grid function.

Definition at line 390 of file gridfunc.hpp.

Member Function Documentation

◆ AccumulateAndCountZones() [1/2]

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 1201 of file gridfunc.cpp.

◆ AccumulateAndCountZones() [2/2]

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 1239 of file gridfunc.cpp.

◆ ComputeFlux()

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

Reimplemented in mfem::ParGridFunction.

Definition at line 276 of file gridfunc.cpp.

◆ ComputeH1Error()

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

Definition at line 1864 of file gridfunc.cpp.

◆ ComputeL1Error() [1/2]

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

Reimplemented in mfem::ParGridFunction.

Definition at line 293 of file gridfunc.hpp.

◆ ComputeL1Error() [2/2]

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

Reimplemented in mfem::ParGridFunction.

Definition at line 301 of file gridfunc.hpp.

◆ ComputeL2Error() [1/3]

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

Reimplemented in mfem::ParGridFunction.

Definition at line 263 of file gridfunc.hpp.

◆ ComputeL2Error() [2/3]

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

Reimplemented in mfem::ParGridFunction.

Definition at line 1762 of file gridfunc.cpp.

◆ ComputeL2Error() [3/3]

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

Reimplemented in mfem::ParGridFunction.

Definition at line 1819 of file gridfunc.cpp.

◆ ComputeLpError() [1/2]

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 2175 of file gridfunc.cpp.

◆ ComputeLpError() [2/2]

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 2240 of file gridfunc.cpp.

◆ ComputeMaxError() [1/3]

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

Reimplemented in mfem::ParGridFunction.

Definition at line 278 of file gridfunc.hpp.

◆ ComputeMaxError() [2/3]

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

Reimplemented in mfem::ParGridFunction.

Definition at line 2012 of file gridfunc.cpp.

◆ ComputeMaxError() [3/3]

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

Reimplemented in mfem::ParGridFunction.

Definition at line 287 of file gridfunc.hpp.

◆ ComputeMeans()

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

Definition at line 1291 of file gridfunc.cpp.

◆ ComputeW11Error()

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

Definition at line 2069 of file gridfunc.cpp.

◆ Destroy()

void mfem::GridFunction::Destroy ( )
protected

Definition at line 137 of file gridfunc.cpp.

◆ FESpace() [1/2]

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

Definition at line 337 of file gridfunc.hpp.

◆ FESpace() [2/2]

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

Definition at line 338 of file gridfunc.hpp.

◆ GetBdrValuesFrom()

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

Definition at line 651 of file gridfunc.cpp.

◆ GetCurl()

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

Definition at line 943 of file gridfunc.cpp.

◆ GetDerivative()

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

Definition at line 828 of file gridfunc.cpp.

◆ GetDivergence()

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

Definition at line 907 of file gridfunc.cpp.

◆ GetElementAverages()

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 1054 of file gridfunc.cpp.

◆ GetFaceValues()

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

Definition at line 467 of file gridfunc.cpp.

◆ GetFaceVectorValues()

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

Definition at line 571 of file gridfunc.cpp.

◆ GetGradient()

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

Definition at line 996 of file gridfunc.cpp.

◆ GetGradients()

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

Definition at line 1015 of file gridfunc.cpp.

◆ GetNodalValues() [1/2]

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 344 of file gridfunc.cpp.

◆ GetNodalValues() [2/2]

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 1175 of file gridfunc.cpp.

◆ GetTrueDofs()

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.

Definition at line 312 of file gridfunc.cpp.

◆ GetTrueVector() [1/2]

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 105 of file gridfunc.hpp.

◆ GetTrueVector() [2/2]

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 109 of file gridfunc.hpp.

◆ GetValue()

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

Reimplemented in mfem::ParGridFunction.

Definition at line 385 of file gridfunc.cpp.

◆ GetValues() [1/2]

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

Definition at line 434 of file gridfunc.cpp.

◆ GetValues() [2/2]

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

Definition at line 456 of file gridfunc.cpp.

◆ GetValuesFrom()

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

Definition at line 614 of file gridfunc.cpp.

◆ GetVectorFieldNodalValues()

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

Definition at line 757 of file gridfunc.cpp.

◆ GetVectorFieldValues()

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

Definition at line 688 of file gridfunc.cpp.

◆ GetVectorGradient()

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

Definition at line 1040 of file gridfunc.cpp.

◆ GetVectorGradientHat()

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

Definition at line 888 of file gridfunc.cpp.

◆ GetVectorValue()

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

Definition at line 400 of file gridfunc.cpp.

◆ GetVectorValues() [1/2]

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

Definition at line 517 of file gridfunc.cpp.

◆ GetVectorValues() [2/2]

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

Definition at line 562 of file gridfunc.cpp.

◆ ImposeBounds() [1/2]

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 1117 of file gridfunc.cpp.

◆ ImposeBounds() [2/2]

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

Definition at line 1144 of file gridfunc.cpp.

◆ MakeOwner()

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

Make the GridFunction the owner of 'fec' and 'fes'.

Definition at line 96 of file gridfunc.hpp.

◆ MakeRef() [1/2]

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 182 of file gridfunc.cpp.

◆ MakeRef() [2/2]

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 190 of file gridfunc.cpp.

◆ MakeTRef() [1/2]

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

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

Definition at line 199 of file gridfunc.cpp.

◆ MakeTRef() [2/2]

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 213 of file gridfunc.cpp.

◆ operator=() [1/3]

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

Redefine '=' for GridFunction = constant.

Definition at line 2331 of file gridfunc.cpp.

◆ operator=() [2/3]

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

Copy the data from v.

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

Definition at line 2337 of file gridfunc.cpp.

◆ operator=() [3/3]

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

Copy the data from v.

The GridFunctions v and *this must have FiniteElementSpaces with the same size.

Definition at line 2344 of file gridfunc.cpp.

◆ OwnFEC()

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

Definition at line 98 of file gridfunc.hpp.

◆ ProjectBdrCoefficient() [1/2]

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

Definition at line 243 of file gridfunc.hpp.

◆ ProjectBdrCoefficient() [2/2]

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

Definition at line 1565 of file gridfunc.cpp.

◆ ProjectBdrCoefficientNormal()

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 1646 of file gridfunc.cpp.

◆ ProjectBdrCoefficientTangent()

void mfem::GridFunction::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.

Definition at line 1717 of file gridfunc.cpp.

◆ ProjectCoefficient() [1/5]

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

Reimplemented in mfem::ParGridFunction.

Definition at line 1377 of file gridfunc.cpp.

◆ ProjectCoefficient() [2/5]

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

Definition at line 1404 of file gridfunc.cpp.

◆ ProjectCoefficient() [3/5]

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

Definition at line 1428 of file gridfunc.cpp.

◆ ProjectCoefficient() [4/5]

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

Definition at line 1443 of file gridfunc.cpp.

◆ ProjectCoefficient() [5/5]

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

Definition at line 1473 of file gridfunc.cpp.

◆ ProjectDeltaCoefficient()

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

Definition at line 1314 of file gridfunc.cpp.

◆ ProjectDiscCoefficient() [1/4]

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 1508 of file gridfunc.cpp.

◆ ProjectDiscCoefficient() [2/4]

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 1539 of file gridfunc.cpp.

◆ ProjectDiscCoefficient() [3/4]

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 1545 of file gridfunc.cpp.

◆ ProjectDiscCoefficient() [4/4]

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 1556 of file gridfunc.cpp.

◆ ProjectGridFunction()

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 1084 of file gridfunc.cpp.

◆ ProjectVectorFieldOn()

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

Definition at line 788 of file gridfunc.cpp.

◆ ReorderByNodes()

void mfem::GridFunction::ReorderByNodes ( )

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

Definition at line 730 of file gridfunc.cpp.

◆ Save()

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

Save the GridFunction to an output stream.

Reimplemented in mfem::ParGridFunction.

Definition at line 2349 of file gridfunc.cpp.

◆ SaveSTL()

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

Definition at line 2471 of file gridfunc.cpp.

◆ SaveSTLTri()

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

Definition at line 2451 of file gridfunc.cpp.

◆ SaveVTK()

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 2374 of file gridfunc.cpp.

◆ SetFromTrueDofs()

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

Set the GridFunction from the given true-dof vector.

Reimplemented in mfem::ParGridFunction.

Definition at line 327 of file gridfunc.cpp.

◆ SetFromTrueVector()

void mfem::GridFunction::SetFromTrueVector ( )
inline

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

Definition at line 122 of file gridfunc.hpp.

◆ SetSpace()

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 174 of file gridfunc.cpp.

◆ SetTrueVector()

void mfem::GridFunction::SetTrueVector ( )
inline

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

Definition at line 116 of file gridfunc.hpp.

◆ SumFluxAndCount()

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

Definition at line 229 of file gridfunc.cpp.

◆ Update()

void mfem::GridFunction::Update ( )
virtual

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

Reimplemented in mfem::ParGridFunction.

Definition at line 147 of file gridfunc.cpp.

◆ VectorDim()

int mfem::GridFunction::VectorDim ( ) const

Definition at line 291 of file gridfunc.cpp.

Member Data Documentation

◆ fec

FiniteElementCollection* mfem::GridFunction::fec
protected

Used when the grid function is read from a file.

Definition at line 34 of file gridfunc.hpp.

◆ fes

FiniteElementSpace* mfem::GridFunction::fes
protected

FE space on which grid function lives.

Definition at line 31 of file gridfunc.hpp.

◆ sequence

long mfem::GridFunction::sequence
protected

Definition at line 36 of file gridfunc.hpp.

◆ t_vec

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 41 of file gridfunc.hpp.


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