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

#include <gridfunc.hpp>

Inheritance diagram for mfem::GridFunction:

Collaboration diagram for mfem::GridFunction:

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...

FiniteElementCollection *	OwnFEC ()

int	VectorDim () const

const Vector &	GetTrueVector () const
	Read only access to the (optional) internal true-dof Vector. More...

Vector &	GetTrueVector ()
	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)

GridFunction &	operator= (double value)
	Redefine '=' for GridFunction = constant. More...

GridFunction &	operator= (const Vector &v)
	Copy the data from v. More...

GridFunction &	operator= (const GridFunction &v)
	Copy the data from v. More...

virtual void	Update ()
	Transform by the Space UpdateMatrix (e.g., on Mesh change). More...

FiniteElementSpace *	FESpace ()

const FiniteElementSpace *	FESpace () 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...

Vector &	operator= (const double *v)
	Copy Size() entries from v. More...

Vector &	operator= (const Vector &v)
	Redefine '=' for vector = vector. More...

Vector &	operator= (double value)
	Redefine '=' for vector = constant. More...

Vector &	operator*= (double c)

Vector &	operator/= (double c)

Vector &	operator-= (double c)

Vector &	operator-= (const Vector &v)

Vector &	operator+= (const Vector &v)

Vector &	Add (const double a, const Vector &Va)
	(this) += a Va More...

Vector &	Set (const double a, const Vector &x)
	(this) = a x More...

void	SetVector (const Vector &v, int offset)

void	Neg ()
	(this) = -(this) More...

void	Swap (Vector &other)
	Swap the contents of two Vectors. More...

void	median (const Vector &lo, const Vector &hi)
	v = median(v,lo,hi) entrywise. Implementation assumes lo <= hi. More...

void	GetSubVector (const Array< int > &dofs, Vector &elemvect) const

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
FiniteElementSpace *	fes
	FE space on which grid function lives. More...

FiniteElementCollection *	fec
	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

enum mfem::GridFunction::AvgType

Enumerator
ARITHMETIC
HARMONIC

Definition at line 218 of file gridfunc.hpp.

Constructor & Destructor Documentation

mfem::GridFunction::GridFunction ( )

inline

Definition at line 68 of file gridfunc.hpp.

mfem::GridFunction::GridFunction ( const GridFunction & orig )

inline

Copy constructor.

Definition at line 71 of file gridfunc.hpp.

mfem::GridFunction::GridFunction ( FiniteElementSpace * f )

inline

Construct a GridFunction associated with the FiniteElementSpace *f.

Definition at line 75 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 84 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 61 of file gridfunc.cpp.

virtual mfem::GridFunction::~GridFunction ( )

inlinevirtual

Destroys grid function.

Definition at line 390 of file gridfunc.hpp.

Member Function Documentation

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.

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.

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

virtual

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation