Class for parallel linear form. More...

#include <plinearform.hpp>

Inheritance diagram for mfem::ParLinearForm:

Collaboration diagram for mfem::ParLinearForm:

Public Member Functions
	ParLinearForm ()
	Create an empty ParLinearForm without an associated ParFiniteElementSpace. More...

	ParLinearForm (ParFiniteElementSpace *pf)
	Create a ParLinearForm on the FE space *pf. More...

	ParLinearForm (ParFiniteElementSpace pf, double data)
	Construct a ParLinearForm using previously allocated array data. More...

	ParLinearForm (ParFiniteElementSpace pf, ParLinearForm plf)
	Create a ParLinearForm on the ParFiniteElementSpace pf, using the same integrators as the ParLinearForm plf. More...

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

ParFiniteElementSpace *	ParFESpace () const

void	Update (ParFiniteElementSpace *pf=NULL)
	Update the object according to the given new FE space *pf. More...

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

virtual void	MakeRef (FiniteElementSpace *f, Vector &v, int v_offset)
	Make the ParLinearForm reference external data on a new FiniteElementSpace. More...

void	MakeRef (ParFiniteElementSpace *pf, Vector &v, int v_offset)
	Make the ParLinearForm reference external data on a new ParFiniteElementSpace. More...

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

virtual bool	SupportsDevice ()
	Return true if assembly on device is supported, false otherwise. More...

void	AssembleSharedFaces ()

void	ParallelAssemble (Vector &tv)
	Assemble the vector on the true dofs, i.e. P^t v. More...

HypreParVector *	ParallelAssemble ()
	Returns the vector assembled on the true dofs, i.e. P^t v. More...

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

ParLinearForm &	operator= (double value)
	Assign constant values to the ParLinearForm data. More...

ParLinearForm &	operator= (const Vector &v)
	Copy the data from a Vector to the ParLinearForm data. More...

Public Member Functions inherited from mfem::LinearForm
	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...

MFEM_DEPRECATED 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	AddDomainIntegrator (LinearFormIntegrator *lfi, Array< int > &elem_marker)

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

void	AddInteriorFaceIntegrator (LinearFormIntegrator *lfi)
	Adds new Interior Face Integrator. Assumes ownership of lfi. More...

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

Array< Array< int > * > *	GetDLFI_Marker ()
	Access all domain markers added with AddDomainIntegrator(). If no marker was specified when the integrator was added, the corresponding pointer (to Array<int>) will be NULL. 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< LinearFormIntegrator * > *	GetIFLFI ()
	Access all integrators added with AddInteriorFaceIntegrator(). 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	UseFastAssembly (bool use_fa)
	Which assembly algorithm to use: the new device-compatible fast assembly (true), or the legacy CPU-only algorithm (false). 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 ()

	Vector (const Vector &)
	Copy constructor. Allocates a new data array and copies the data. More...

	Vector (Vector &&v)
	Move constructor. "Steals" data from its argument. More...

	Vector (int s)
	Creates vector of size s. More...

	Vector (double *data_, int size_)
	Creates a vector referencing an array of doubles, owned by someone else. More...

	Vector (Vector &base, int base_offset, int size_)
	Create a Vector referencing a sub-vector of the Vector base starting at the given offset, base_offset, and size size_. More...

	Vector (int size_, MemoryType mt)
	Create a Vector of size size_ using MemoryType mt. More...

	Vector (int size_, MemoryType h_mt, MemoryType d_mt)
	Create a Vector of size size_ using host MemoryType h_mt and device MemoryType d_mt. More...

template<int N>
	Vector (const double(&values)[N])
	Create a vector using a braced initializer list. More...

virtual void	UseDevice (bool use_dev) const
	Enable execution of Vector operations using the mfem::Device. More...

virtual bool	UseDevice () const
	Return the device flag of the Memory object used by the Vector. More...

void	Load (std::istream *in, int np, int dim)
	Reads a vector from multiple files. More...

void	Load (std::istream &in, int Size)
	Load a vector from an input stream. More...

void	Load (std::istream &in)
	Load a vector from an input stream, reading the size from the stream. More...

void	SetSize (int s)
	Resize the vector to size s. More...

void	SetSize (int s, MemoryType mt)
	Resize the vector to size s using MemoryType mt. More...

void	SetSize (int s, Vector &v)
	Resize the vector to size s using the MemoryType of v. More...

void	SetData (double *d)

void	SetDataAndSize (double *d, int s)
	Set the Vector data and size. More...

void	NewDataAndSize (double *d, int s)
	Set the Vector data and size, deleting the old data, if owned. More...

void	NewMemoryAndSize (const Memory< double > &mem, int s, bool own_mem)
	Reset the Vector to use the given external Memory mem and size s. More...

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

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

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

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

void	DeleteDevice (bool copy_to_host=true)
	Delete the device pointer, if owned. If copy_to_host is true and the data is valid only on device, move it to host before deleting. Invalidates the device memory. More...

int	Size () const
	Returns the size of the vector. More...

int	Capacity () const
	Return the size of the currently allocated data array. More...

double *	GetData () const
	Return a pointer to the beginning of the Vector data. More...

	operator double * ()
	Conversion to `double *`. More...

	operator const double * () const
	Conversion to `const double *`. More...

double *	begin ()
	STL-like begin. More...

double *	end ()
	STL-like end. More...

const double *	begin () const
	STL-like begin (const version). More...

const double *	end () const
	STL-like end (const version). More...

Memory< double > &	GetMemory ()
	Return a reference to the Memory object used by the Vector. More...

const Memory< double > &	GetMemory () const
	Return a reference to the Memory object used by the Vector, const version. More...

void	SyncMemory (const Vector &v) const
	Update the memory location of the vector to match v. More...

void	SyncAliasMemory (const Vector &v) const
	Update the alias memory location of the vector to match v. More...

bool	OwnsData () const
	Read the Vector data (host pointer) ownership flag. More...

void	StealData (double **p)
	Changes the ownership of the data; after the call the Vector is empty. More...

double *	StealData ()
	Changes the ownership of the data; after the call the Vector is empty. More...

double &	Elem (int i)
	Access Vector entries. Index i = 0 .. size-1. More...

const double &	Elem (int i) const
	Read only access to Vector entries. Index i = 0 .. size-1. More...

double &	operator() (int i)
	Access Vector entries using () for 0-based indexing. More...

const double &	operator() (int i) const
	Read only access to Vector entries using () for 0-based indexing. More...

double	operator* (const double *) const
	Dot product with a `double *` array. More...

double	operator* (const Vector &v) const
	Return the inner-product. More...

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

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

Vector &	operator= (Vector &&v)
	Move assignment. More...

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

Vector &	operator*= (double c)

Vector &	operator*= (const Vector &v)
	Component-wise scaling: (this)(i) = v(i) More...

Vector &	operator/= (double c)

Vector &	operator/= (const Vector &v)
	Component-wise division: (*this)(i) /= v(i) More...

Vector &	operator-= (double c)

Vector &	operator-= (const Vector &v)

Vector &	operator+= (double c)

Vector &	operator+= (const Vector &v)

Vector &	operator- (const Vector &v)=delete
	operator- is not supported. Use subtract or Add. More...

Vector &	operator+ (const Vector &v)=delete
	operator+ is not supported. Use Add. More...

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

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

void	SetVector (const Vector &v, int offset)

void	AddSubVector (const Vector &v, int offset)

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

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

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

void	GetSubVector (const Array< int > &dofs, Vector &elemvect) const
	Extract entries listed in dofs to the output Vector elemvect. More...

void	GetSubVector (const Array< int > &dofs, double *elem_data) const
	Extract entries listed in dofs to the output array elem_data. More...

void	SetSubVector (const Array< int > &dofs, const double value)
	Set the entries listed in dofs to the given value. More...

void	SetSubVector (const Array< int > &dofs, const Vector &elemvect)
	Set the entries listed in dofs to the values given in the elemvect Vector. Negative dof values cause the -dof-1 position in this Vector to receive the -val from elemvect. More...

void	SetSubVector (const Array< int > &dofs, double *elem_data)
	Set the entries listed in dofs to the values given the , elem_data array. Negative dof values cause the -dof-1 position in this Vector to receive the -val from elem_data. More...

void	AddElementVector (const Array< int > &dofs, const Vector &elemvect)
	Add elements of the elemvect Vector to the entries listed in dofs. Negative dof values cause the -dof-1 position in this Vector to add the -val from elemvect. More...

void	AddElementVector (const Array< int > &dofs, double *elem_data)
	Add elements of the elem_data array to the entries listed in dofs. Negative dof values cause the -dof-1 position in this Vector to add the -val from elem_data. More...

void	AddElementVector (const Array< int > &dofs, const double a, const Vector &elemvect)
	Add times the elements of the elemvect Vector to the entries listed in dofs. Negative dof values cause the -dof-1 position in this Vector to add the -aval from elemvect*. More...

void	SetSubVectorComplement (const Array< int > &dofs, const double val)
	Set all vector entries NOT in the dofs Array to the given val. More...

void	Print (std::ostream &out=mfem::out, int width=8) const
	Prints vector to stream out. More...

void	Print (adios2stream &out, const std::string &variable_name) const

void	Print_HYPRE (std::ostream &out) const
	Prints vector to stream out in HYPRE_Vector format. More...

void	PrintHash (std::ostream &out) const
	Print the Vector size and hash of its data. More...

void	Randomize (int seed=0)
	Set random values in the vector. More...

void	SetGlobalSeed (int gseed)
	Set global seed for random values in sequential calls to Randomize(). More...

double	Norml2 () const
	Returns the l2 norm of the vector. More...

double	Normlinf () const
	Returns the l_infinity norm of the vector. More...

double	Norml1 () const
	Returns the l_1 norm of the vector. More...

double	Normlp (double p) const
	Returns the l_p norm of the vector. More...

double	Max () const
	Returns the maximal element of the vector. More...

double	Min () const
	Returns the minimal element of the vector. More...

double	Sum () const
	Return the sum of the vector entries. More...

double	DistanceSquaredTo (const double *p) const
	Compute the square of the Euclidean distance to another vector. More...

double	DistanceTo (const double *p) const
	Compute the Euclidean distance to another vector. More...

int	CheckFinite () const
	Count the number of entries in the Vector for which isfinite is false, i.e. the entry is a NaN or +/-Inf. More...

virtual	~Vector ()
	Destroys vector. More...

virtual const double *	Read (bool on_dev=true) const
	Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), on_dev). More...

virtual const double *	HostRead () const
	Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), false). More...

virtual double *	Write (bool on_dev=true)
	Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), on_dev). More...

virtual double *	HostWrite ()
	Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), false). More...

virtual double *	ReadWrite (bool on_dev=true)
	Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), on_dev). More...

virtual double *	HostReadWrite ()
	Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), false). More...

Protected Attributes
ParFiniteElementSpace *	pfes
	Points to the same object as fes. More...

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

LinearFormExtension *	ext = nullptr
	Extension for supporting different assembly levels. More...

bool	fast_assembly = false
	Should we use the device-compatible fast assembly algorithm (false by default) More...

int	extern_lfs = 0
	Indicates the LinearFormIntegrators stored in domain_integs, domain_delta_integs, boundary_integs, and boundary_face_integs are owned by another LinearForm. More...

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

Array< Array< int > * >	domain_integs_marker

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

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

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

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

Array< Array< int > * >	boundary_face_integs_marker
	Entries not owned. More...

Array< LinearFormIntegrator * >	interior_face_integs
	Set of Internal Face Integrators to be applied. More...

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

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

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

int	size

bool	global_seed_set = false

Additional Inherited Members
Protected Member Functions inherited from mfem::LinearForm
bool	HaveDeltaLocations ()
	If true, the delta locations are not (re)computed during assembly. More...

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

Detailed Description

Class for parallel linear form.

Definition at line 26 of file plinearform.hpp.

Constructor & Destructor Documentation

mfem::ParLinearForm::ParLinearForm ( )

inline

Create an empty ParLinearForm without an associated ParFiniteElementSpace.

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

Definition at line 42 of file plinearform.hpp.

mfem::ParLinearForm::ParLinearForm ( ParFiniteElementSpace * pf )

inline

Create a ParLinearForm on the FE space *pf.

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

Definition at line 46 of file plinearform.hpp.

mfem::ParLinearForm::ParLinearForm	(	ParFiniteElementSpace *	pf,
		double *	data
	)

inline

Construct a ParLinearForm using previously allocated array data.

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

Definition at line 54 of file plinearform.hpp.

mfem::ParLinearForm::ParLinearForm	(	ParFiniteElementSpace *	pf,
		ParLinearForm *	plf
	)

inline

Create a ParLinearForm on the ParFiniteElementSpace *pf, using the same integrators as the ParLinearForm *plf.

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

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

Definition at line 64 of file plinearform.hpp.

Member Function Documentation

void mfem::ParLinearForm::Assemble ( )

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

When UseFastAssembly(true) has been called and the linear form assembly is compatible with device execution, the assembly will be executed on the device.

Definition at line 46 of file plinearform.cpp.

void mfem::ParLinearForm::AssembleSharedFaces ( )

Definition at line 65 of file plinearform.cpp.

void mfem::ParLinearForm::MakeRef	(	FiniteElementSpace *	f,
		Vector &	v,
		int	v_offset
	)

virtual

Make the ParLinearForm reference external data on a new FiniteElementSpace.

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

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

Reimplemented from mfem::LinearForm.

Definition at line 33 of file plinearform.cpp.

void mfem::ParLinearForm::MakeRef	(	ParFiniteElementSpace *	pf,
		Vector &	v,
		int	v_offset
	)

Make the ParLinearForm reference external data on a new ParFiniteElementSpace.

This method changes the ParFiniteElementSpace associated with the ParLinearForm to *pf and sets the data of the Vector v (plus the v_offset) as external data in the ParLinearForm.

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

Definition at line 40 of file plinearform.cpp.

double mfem::ParLinearForm::operator() ( const ParGridFunction & gf ) const

inline

Return the action of the ParLinearForm as a linear mapping.

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

Definition at line 138 of file plinearform.hpp.

ParLinearForm& mfem::ParLinearForm::operator= ( const ParLinearForm & rhs )

inline

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

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

Note: Defining this method overwrites the implicitly defined copy assignment operator.

Definition at line 73 of file plinearform.hpp.

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

inline

Assign constant values to the ParLinearForm data.

Definition at line 144 of file plinearform.hpp.

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

inline

Copy the data from a Vector to the ParLinearForm data.

Definition at line 148 of file plinearform.hpp.

void mfem::ParLinearForm::ParallelAssemble ( Vector & tv )

Assemble the vector on the true dofs, i.e. P^t v.

Definition at line 95 of file plinearform.cpp.

HypreParVector * mfem::ParLinearForm::ParallelAssemble ( )

Returns the vector assembled on the true dofs, i.e. P^t v.

Definition at line 101 of file plinearform.cpp.

ParFiniteElementSpace* mfem::ParLinearForm::ParFESpace ( ) const

inline

Definition at line 76 of file plinearform.hpp.

bool mfem::ParLinearForm::SupportsDevice ( )

virtual

Return true if assembly on device is supported, false otherwise.

Reimplemented from mfem::LinearForm.

Definition at line 57 of file plinearform.cpp.

void mfem::ParLinearForm::Update ( ParFiniteElementSpace * pf = NULL )

Update the object according to the given new FE space *pf.

If the pointer pf is NULL (this is the default value), the FE space already associated with this object is used.

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 21 of file plinearform.cpp.

void mfem::ParLinearForm::Update	(	ParFiniteElementSpace *	pf,
		Vector &	v,
		int	v_offset
	)

Associate a new FE space, *pf, 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 27 of file plinearform.cpp.

Member Data Documentation

ParFiniteElementSpace* mfem::ParLinearForm::pfes

protected

Points to the same object as fes.

Definition at line 29 of file plinearform.hpp.

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

fem/plinearform.hpp
fem/plinearform.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation