Class for linear form - Vector with associated FE space and LFIntegrators. More...

#include <linearform.hpp>

Inheritance diagram for mfem::LinearForm:

Collaboration diagram for mfem::LinearForm:

Public Member Functions
	LinearForm (FiniteElementSpace *f)
	Creates linear form associated with FE space *f. More...

	LinearForm (FiniteElementSpace f, LinearForm lf)
	Create a LinearForm on the FiniteElementSpace f, using the same integrators as the LinearForm lf. More...

	LinearForm ()
	Create an empty LinearForm without an associated FiniteElementSpace. More...

	LinearForm (FiniteElementSpace f, double data)
	Construct a LinearForm using previously allocated array data. More...

LinearForm &	operator= (const LinearForm &rhs)
	Copy assignment. Only the data of the base class Vector is copied. More...

FiniteElementSpace *	GetFES ()
	(DEPRECATED) Return the FE space associated with the LinearForm. More...

FiniteElementSpace *	FESpace ()
	Read+write access to the associated FiniteElementSpace. More...

const FiniteElementSpace *	FESpace () const
	Read-only access to the associated FiniteElementSpace. More...

void	AddDomainIntegrator (LinearFormIntegrator *lfi)
	Adds new Domain Integrator. Assumes ownership of lfi. More...

void	AddBoundaryIntegrator (LinearFormIntegrator *lfi)
	Adds new Boundary Integrator. Assumes ownership of lfi. More...

void	AddBoundaryIntegrator (LinearFormIntegrator *lfi, Array< int > &bdr_attr_marker)
	Add new Boundary Integrator, restricted to the given boundary attributes. More...

void	AddBdrFaceIntegrator (LinearFormIntegrator *lfi)
	Adds new Boundary Face Integrator. Assumes ownership of lfi. More...

void	AddBdrFaceIntegrator (LinearFormIntegrator *lfi, Array< int > &bdr_attr_marker)
	Add new Boundary Face Integrator, restricted to the given boundary attributes. More...

Array< LinearFormIntegrator * > *	GetDLFI ()
	Access all integrators added with AddDomainIntegrator() which are not DeltaLFIntegrators or they are DeltaLFIntegrators with non-delta coefficients. More...

Array< DeltaLFIntegrator * > *	GetDLFI_Delta ()
	Access all integrators added with AddDomainIntegrator() which are DeltaLFIntegrators with delta coefficients. More...

Array< LinearFormIntegrator * > *	GetBLFI ()
	Access all integrators added with AddBoundaryIntegrator(). More...

Array< LinearFormIntegrator * > *	GetFLFI ()
	Access all integrators added with AddBdrFaceIntegrator(). More...

Array< Array< int > * > *	GetFLFI_Marker ()
	Access all boundary markers added with AddBdrFaceIntegrator(). If no marker was specified when the integrator was added, the corresponding pointer (to Array<int>) will be NULL. More...

void	Assemble ()
	Assembles the linear form i.e. sums over all domain/bdr integrators. More...

void	AssembleDelta ()
	Assembles delta functions of the linear form. More...

void	Update ()
	Update the object according to the associated FE space fes. More...

void	Update (FiniteElementSpace *f)
	Associate a new FE space, f, with this object and Update() it. /. More...

void	Update (FiniteElementSpace *f, Vector &v, int v_offset)
	Associate a new FE space, f, with this object and use the data of v, offset by v_offset*, to initialize this object's Vector::data. More...

double	operator() (const GridFunction &gf) const
	Return the action of the LinearForm as a linear mapping. More...

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

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

	~LinearForm ()
	Destroys linear form. 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	MakeRef (Vector &base, int offset, int size)
	Reset the Vector to be a reference to a sub-vector of base. More...

void	MakeRef (Vector &base, int offset)
	Reset the Vector to be a reference to a sub-vector of base without changing its current size. More...

void	MakeDataOwner () const
	Set the Vector data (host pointer) ownership flag. More...

void	Destroy ()
	Destroy a vector. More...

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

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

Vector &	operator= (const Vector &v)
	Copy assignment. More...

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

Vector &	operator*= (double c)

Vector &	operator/= (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
	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
bool	HaveDeltaLocations ()
	If true, the delta locations are not (re)computed during assembly. More...

void	ResetDeltaLocations ()
	Force (re)computation of delta locations. More...

Protected Attributes
FiniteElementSpace *	fes
	FE space on which the LinearForm lives. Not owned. More...

int	extern_lfs
	Indicates the LinerFormIntegrators stored in dlfi, dlfi_delta, blfi, and flfi are owned by another LinearForm. More...

Array< LinearFormIntegrator * >	dlfi
	Set of Domain Integrators to be applied. More...

Array< DeltaLFIntegrator * >	dlfi_delta
	Separate array for integrators with delta function coefficients. More...

Array< LinearFormIntegrator * >	blfi
	Set of Boundary Integrators to be applied. More...

Array< Array< int > * >	blfi_marker
	Entries are not owned. More...

Array< LinearFormIntegrator * >	flfi
	Set of Boundary Face Integrators to be applied. More...

Array< Array< int > * >	flfi_marker
	Entries are not owned. More...

Array< int >	dlfi_delta_elem_id
	The element ids where the centers of the delta functions lie. More...

Array< IntegrationPoint >	dlfi_delta_ip
	The reference coordinates where the centers of the delta functions lie. More...

Protected Attributes inherited from mfem::Vector
Memory< double >	data

int	size

Detailed Description

Class for linear form - Vector with associated FE space and LFIntegrators.

Definition at line 23 of file linearform.hpp.

Constructor & Destructor Documentation

mfem::LinearForm::LinearForm ( FiniteElementSpace * f )

inline

Creates linear form associated with FE space *f.

The pointer f is not owned by the newly constructed object.

Definition at line 66 of file linearform.hpp.

mfem::LinearForm::LinearForm	(	FiniteElementSpace *	f,
		LinearForm *	lf
	)

Create a LinearForm on the FiniteElementSpace f, using the same integrators as the LinearForm lf.

The pointer f is not owned by the newly constructed object.

The integrators in lf are copied as pointers and they are not owned by the newly constructed LinearForm.

Definition at line 19 of file linearform.cpp.

mfem::LinearForm::LinearForm ( )

inline

Create an empty LinearForm without an associated FiniteElementSpace.

The associated FiniteElementSpace can be set later using one of the methods: Update(FiniteElementSpace *) or Update(FiniteElementSpace *, Vector &, int).

Definition at line 82 of file linearform.hpp.

mfem::LinearForm::LinearForm	(	FiniteElementSpace *	f,
		double *	data
	)

inline

Construct a LinearForm using previously allocated array data.

The LinearForm 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 89 of file linearform.hpp.

mfem::LinearForm::~LinearForm ( )

Destroys linear form.

Definition at line 259 of file linearform.cpp.

Member Function Documentation

void mfem::LinearForm::AddBdrFaceIntegrator ( LinearFormIntegrator * lfi )

Adds new Boundary Face Integrator. Assumes ownership of lfi.

Definition at line 66 of file linearform.cpp.

void mfem::LinearForm::AddBdrFaceIntegrator	(	LinearFormIntegrator *	lfi,
		Array< int > &	bdr_attr_marker
	)

Add new Boundary Face Integrator, restricted to the given boundary attributes.

Assumes ownership of lfi. The array bdr_attr_marker is stored internally as a pointer to the given Array<int> object.

Definition at line 72 of file linearform.cpp.

void mfem::LinearForm::AddBoundaryIntegrator ( LinearFormIntegrator * lfi )

Adds new Boundary Integrator. Assumes ownership of lfi.

Definition at line 53 of file linearform.cpp.

void mfem::LinearForm::AddBoundaryIntegrator	(	LinearFormIntegrator *	lfi,
		Array< int > &	bdr_attr_marker
	)

Add new Boundary Integrator, restricted to the given boundary attributes.

Assumes ownership of lfi. The array bdr_attr_marker is stored internally as a pointer to the given Array<int> object.

Definition at line 59 of file linearform.cpp.

void mfem::LinearForm::AddDomainIntegrator ( LinearFormIntegrator * lfi )

Adds new Domain Integrator. Assumes ownership of lfi.

Definition at line 39 of file linearform.cpp.

void mfem::LinearForm::Assemble ( )

Assembles the linear form i.e. sums over all domain/bdr integrators.

Definition at line 79 of file linearform.cpp.

void mfem::LinearForm::AssembleDelta ( )

Assembles delta functions of the linear form.

Definition at line 206 of file linearform.cpp.

FiniteElementSpace* mfem::LinearForm::FESpace ( )

inline

Read+write access to the associated FiniteElementSpace.

Definition at line 106 of file linearform.hpp.

const FiniteElementSpace* mfem::LinearForm::FESpace ( ) const

inline

Read-only access to the associated FiniteElementSpace.

Definition at line 108 of file linearform.hpp.

Array<LinearFormIntegrator*>* mfem::LinearForm::GetBLFI ( )

inline

Access all integrators added with AddBoundaryIntegrator().

Definition at line 145 of file linearform.hpp.

Array<LinearFormIntegrator*>* mfem::LinearForm::GetDLFI ( )

inline

Access all integrators added with AddDomainIntegrator() which are not DeltaLFIntegrators or they are DeltaLFIntegrators with non-delta coefficients.

Definition at line 138 of file linearform.hpp.

Array<DeltaLFIntegrator*>* mfem::LinearForm::GetDLFI_Delta ( )

inline

Access all integrators added with AddDomainIntegrator() which are DeltaLFIntegrators with delta coefficients.

Definition at line 142 of file linearform.hpp.

FiniteElementSpace* mfem::LinearForm::GetFES ( )

inline

(DEPRECATED) Return the FE space associated with the LinearForm.

Deprecated:: Use FESpace() instead.

Definition at line 103 of file linearform.hpp.

Array<LinearFormIntegrator*>* mfem::LinearForm::GetFLFI ( )

inline

Access all integrators added with AddBdrFaceIntegrator().

Definition at line 148 of file linearform.hpp.

Array<Array<int>*>* mfem::LinearForm::GetFLFI_Marker ( )

inline

Access all boundary markers added with AddBdrFaceIntegrator(). If no marker was specified when the integrator was added, the corresponding pointer (to Array<int>) will be NULL.

Definition at line 153 of file linearform.hpp.

bool mfem::LinearForm::HaveDeltaLocations ( )

inlineprotected

If true, the delta locations are not (re)computed during assembly.

Definition at line 54 of file linearform.hpp.

double mfem::LinearForm::operator() ( const GridFunction & gf ) const

inline

Return the action of the LinearForm as a linear mapping.

Linear forms are linear functionals which map GridFunctions to the real numbers. This method performs this mapping which in this case is equivalent as an inner product of the LinearForm and GridFunction.

Definition at line 183 of file linearform.hpp.

LinearForm& mfem::LinearForm::operator= ( const LinearForm & 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 assignment operator.

Definition at line 98 of file linearform.hpp.

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

Redefine '=' for LinearForm = constant.

Definition at line 246 of file linearform.cpp.

LinearForm & mfem::LinearForm::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 252 of file linearform.cpp.

void mfem::LinearForm::ResetDeltaLocations ( )

inlineprotected

Force (re)computation of delta locations.

Definition at line 57 of file linearform.hpp.

void mfem::LinearForm::Update ( )

inline

Update the object according to the associated FE space fes.

This method should be called when the associated FE space fes has been updated, e.g. after its associated Mesh object has been refined.

Note: This method does not perform assembly.

Definition at line 166 of file linearform.hpp.

void mfem::LinearForm::Update ( FiniteElementSpace * f )

inline

Associate a new FE space, *f, with this object and Update() it. */.

Definition at line 169 of file linearform.hpp.

void mfem::LinearForm::Update	(	FiniteElementSpace *	f,
		Vector &	v,
		int	v_offset
	)

Associate a new FE space, *f, with this object and use the data of v, offset by v_offset, to initialize this object's Vector::data.

Note: This method does not perform assembly.

Definition at line 199 of file linearform.cpp.

Member Data Documentation

Array<LinearFormIntegrator*> mfem::LinearForm::blfi

protected

Set of Boundary Integrators to be applied.

Definition at line 40 of file linearform.hpp.

Array<Array<int>*> mfem::LinearForm::blfi_marker

protected

Entries are not owned.

Definition at line 41 of file linearform.hpp.

Array<LinearFormIntegrator*> mfem::LinearForm::dlfi

protected

Set of Domain Integrators to be applied.

Definition at line 34 of file linearform.hpp.

Array<DeltaLFIntegrator*> mfem::LinearForm::dlfi_delta

protected

Separate array for integrators with delta function coefficients.

Definition at line 37 of file linearform.hpp.

Array<int> mfem::LinearForm::dlfi_delta_elem_id

protected

The element ids where the centers of the delta functions lie.

Definition at line 48 of file linearform.hpp.

Array<IntegrationPoint> mfem::LinearForm::dlfi_delta_ip

protected

The reference coordinates where the centers of the delta functions lie.

Definition at line 51 of file linearform.hpp.

int mfem::LinearForm::extern_lfs

protected

Indicates the LinerFormIntegrators stored in dlfi, dlfi_delta, blfi, and flfi are owned by another LinearForm.

Definition at line 31 of file linearform.hpp.

FiniteElementSpace* mfem::LinearForm::fes

protected

FE space on which the LinearForm lives. Not owned.

Definition at line 27 of file linearform.hpp.

Array<LinearFormIntegrator*> mfem::LinearForm::flfi

protected

Set of Boundary Face Integrators to be applied.

Definition at line 44 of file linearform.hpp.

Array<Array<int>*> mfem::LinearForm::flfi_marker

protected

Entries are not owned.

Definition at line 45 of file linearform.hpp.

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

fem/linearform.hpp
fem/linearform.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation