#include <complex_fem.hpp>

Inheritance diagram for mfem::ParComplexLinearForm:

Collaboration diagram for mfem::ParComplexLinearForm:

Public Member Functions
	ParComplexLinearForm (ParFiniteElementSpace *pf, ComplexOperator::Convention convention=ComplexOperator::HERMITIAN)

	ParComplexLinearForm (ParFiniteElementSpace pf, ParLinearForm plf_r, ParLinearForm *plf_i, ComplexOperator::Convention convention=ComplexOperator::HERMITIAN)
	Create a ParComplexLinearForm on the ParFiniteElementSpace pf, using the same integrators as the LinearForms plf_r (real) and plf_i (imag). More...

virtual	~ParComplexLinearForm ()

ComplexOperator::Convention	GetConvention () const

void	SetConvention (const ComplexOperator::Convention &convention)

void	AddDomainIntegrator (LinearFormIntegrator lfi_real, LinearFormIntegrator lfi_imag)
	Adds new Domain Integrator. More...

void	AddBoundaryIntegrator (LinearFormIntegrator lfi_real, LinearFormIntegrator lfi_imag)
	Adds new Boundary Integrator. More...

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

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

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

ParFiniteElementSpace *	ParFESpace () const

ParLinearForm &	real ()

ParLinearForm &	imag ()

const ParLinearForm &	real () const

const ParLinearForm &	imag () const

void	Sync ()

void	SyncAlias ()

void	Update (ParFiniteElementSpace *pf=NULL)

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

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

std::complex< double >	operator() (const ParComplexGridFunction &gf) const

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+= (double c)

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

MFEM_DEPRECATED	Vector (N_Vector nv)
	(DEPRECATED) Construct a wrapper Vector from SUNDIALS N_Vector. More...

virtual MFEM_DEPRECATED N_Vector	ToNVector ()
	(DEPRECATED) Return a new wrapper SUNDIALS N_Vector of type SUNDIALS_NVEC_SERIAL. More...

virtual MFEM_DEPRECATED void	ToNVector (N_Vector &nv, long global_length=0)
	Update an existing wrapper SUNDIALS N_Vector to point to this Vector. More...

Protected Attributes
ParLinearForm *	plfr

ParLinearForm *	plfi

HYPRE_Int *	tdof_offsets

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

int	size

Detailed Description

Class for a complex-valued, parallel linear form

The convention argument in the class's constructor is documented in the mfem::ComplexOperator class found in linalg/complex_operator.hpp.

When supplying integrators to the ParComplexLinearForm either the real or imaginary integrator can be NULL. This indicates that the corresponding portion of the complex-valued field is equal to zero.

Definition at line 427 of file complex_fem.hpp.

Constructor & Destructor Documentation

mfem::ParComplexLinearForm::ParComplexLinearForm	(	ParFiniteElementSpace *	pf,
		ComplexOperator::Convention	convention = `ComplexOperator::HERMITIAN`
	)

Definition at line 812 of file complex_fem.cpp.

mfem::ParComplexLinearForm::ParComplexLinearForm	(	ParFiniteElementSpace *	pf,
		ParLinearForm *	plf_r,
		ParLinearForm *	plf_i,
		ComplexOperator::Convention	convention = `ComplexOperator::HERMITIAN`
	)

Create a ParComplexLinearForm on the ParFiniteElementSpace pf, using the same integrators as the LinearForms plf_r (real) and plf_i (imag).

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

The integrators are copied as pointers and they are not owned by the newly constructed ParComplexLinearForm.

Definition at line 839 of file complex_fem.cpp.

mfem::ParComplexLinearForm::~ParComplexLinearForm ( )

virtual

Definition at line 867 of file complex_fem.cpp.

Member Function Documentation

void mfem::ParComplexLinearForm::AddBdrFaceIntegrator	(	LinearFormIntegrator *	lfi_real,
		LinearFormIntegrator *	lfi_imag
	)

Adds new Boundary Face Integrator. Assumes ownership of lfi.

Definition at line 900 of file complex_fem.cpp.

void mfem::ParComplexLinearForm::AddBdrFaceIntegrator	(	LinearFormIntegrator *	lfi_real,
		LinearFormIntegrator *	lfi_imag,
		Array< int > &	bdr_attr_marker
	)

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

Assumes ownership of lfi_real and lfi_imag.

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

Definition at line 908 of file complex_fem.cpp.

void mfem::ParComplexLinearForm::AddBoundaryIntegrator	(	LinearFormIntegrator *	lfi_real,
		LinearFormIntegrator *	lfi_imag
	)

Adds new Boundary Integrator.

Definition at line 883 of file complex_fem.cpp.

void mfem::ParComplexLinearForm::AddBoundaryIntegrator	(	LinearFormIntegrator *	lfi_real,
		LinearFormIntegrator *	lfi_imag,
		Array< int > &	bdr_attr_marker
	)

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

Assumes ownership of lfi_real and lfi_imag.

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

Definition at line 891 of file complex_fem.cpp.

void mfem::ParComplexLinearForm::AddDomainIntegrator	(	LinearFormIntegrator *	lfi_real,
		LinearFormIntegrator *	lfi_imag
	)

Adds new Domain Integrator.

Definition at line 875 of file complex_fem.cpp.

void mfem::ParComplexLinearForm::Assemble ( )

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

Definition at line 930 of file complex_fem.cpp.

ComplexOperator::Convention mfem::ParComplexLinearForm::GetConvention ( ) const

inline

Definition at line 459 of file complex_fem.hpp.

ParLinearForm& mfem::ParComplexLinearForm::imag ( )

inline

Definition at line 500 of file complex_fem.hpp.

const ParLinearForm& mfem::ParComplexLinearForm::imag ( ) const

inline

Definition at line 502 of file complex_fem.hpp.

complex< double > mfem::ParComplexLinearForm::operator() ( const ParComplexGridFunction & gf ) const

Definition at line 989 of file complex_fem.cpp.

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

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

Definition at line 942 of file complex_fem.cpp.

HypreParVector * mfem::ParComplexLinearForm::ParallelAssemble ( )

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

Definition at line 962 of file complex_fem.cpp.

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

inline

Definition at line 497 of file complex_fem.hpp.

ParLinearForm& mfem::ParComplexLinearForm::real ( )

inline

Definition at line 499 of file complex_fem.hpp.

const ParLinearForm& mfem::ParComplexLinearForm::real ( ) const

inline

Definition at line 501 of file complex_fem.hpp.

void mfem::ParComplexLinearForm::SetConvention ( const ComplexOperator::Convention & convention )

inline

Definition at line 460 of file complex_fem.hpp.

void mfem::ParComplexLinearForm::Sync ( )

inline

Update the memory location of the real and imaginary ParLinearForm lfr and lfi to match the ParComplexLinearForm.

Definition at line 506 of file complex_fem.hpp.

void mfem::ParComplexLinearForm::SyncAlias ( )

inline

Update the alias memory location of the real and imaginary ParLinearForm plfr and plfi to match the ParComplexLinearForm.

Definition at line 510 of file complex_fem.hpp.

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

Definition at line 917 of file complex_fem.cpp.

Member Data Documentation

ParLinearForm* mfem::ParComplexLinearForm::plfi

protected

Definition at line 434 of file complex_fem.hpp.

ParLinearForm* mfem::ParComplexLinearForm::plfr

protected

Definition at line 433 of file complex_fem.hpp.

HYPRE_Int* mfem::ParComplexLinearForm::tdof_offsets

protected

Definition at line 436 of file complex_fem.hpp.

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

fem/complex_fem.hpp
fem/complex_fem.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation