#include <complex_fem.hpp>

Inheritance diagram for mfem::ParComplexGridFunction:

Collaboration diagram for mfem::ParComplexGridFunction:

Public Member Functions
	ParComplexGridFunction (ParFiniteElementSpace *pf)
	Construct a ParComplexGridFunction associated with the ParFiniteElementSpace *pf.

	ParComplexGridFunction (ParMesh *pmesh, std::istream &input)
	Construct a ParComplexGridFunction on a given ParMesh, pmesh, reading from an std::istream.

void	Update ()

long	GetSequence () const

void	MakeOwner (FiniteElementCollection *fec_)
	Make the ParComplexGridFunction the owner of fec_owned and pfes.

FiniteElementCollection *	OwnFEC ()

int	VectorDim () const

ParComplexGridFunction &	operator= (const std::complex< real_t > &value)
	Assign constant values to the ParComplexGridFunction data.

virtual void	ProjectCoefficient (Coefficient &real_coeff, Coefficient &imag_coeff)

virtual void	ProjectCoefficient (VectorCoefficient &real_vcoeff, VectorCoefficient &imag_vcoeff)

virtual void	ProjectBdrCoefficient (Coefficient &real_coeff, Coefficient &imag_coeff, Array< int > &attr)

virtual void	ProjectBdrCoefficientNormal (VectorCoefficient &real_coeff, VectorCoefficient &imag_coeff, Array< int > &attr)

virtual void	ProjectBdrCoefficientTangent (VectorCoefficient &real_coeff, VectorCoefficient &imag_coeff, Array< int > &attr)

void	Distribute (const Vector *tv)

void	Distribute (const Vector &tv)

void	ParallelProject (Vector &tv) const
	Returns the vector restricted to the true dofs.

FiniteElementSpace *	FESpace ()

const FiniteElementSpace *	FESpace () const

ParFiniteElementSpace *	ParFESpace ()

const ParFiniteElementSpace *	ParFESpace () const

ParGridFunction &	real ()

ParGridFunction &	imag ()

const ParGridFunction &	real () const

const ParGridFunction &	imag () const

void	Sync ()

void	SyncAlias ()

virtual real_t	ComputeL2Error (Coefficient &exsolr, Coefficient &exsoli, const IntegrationRule irs[]=NULL, Array< int > elems=NULL) const
	Returns \|\|u_ex - u_h\|\|_L2 in parallel for complex-valued scalar fields.

virtual real_t	ComputeL2Error (VectorCoefficient &exsolr, VectorCoefficient &exsoli, const IntegrationRule irs[]=NULL, Array< int > elems=NULL) const
	Returns \|\|u_ex - u_h\|\|_L2 in parallel for complex-valued vector fields.

void	Save (std::ostream &out) const
	Save the local portion of the ParComplexGridFunction.

void	Save (const char *fname, int precision=16) const
	Save the ParComplexGridFunction to files.

virtual	~ParComplexGridFunction ()
	Destroys grid function.

Public Member Functions inherited from mfem::Vector
	Vector ()

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

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

	Vector (int s)
	Creates vector of size s.

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

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

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

	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.

template<typename CT , int N>
	Vector (const CT(&values)[N])
	Create a vector from a statically sized C-style array of convertible type.

template<typename CT , typename std::enable_if< std::is_convertible< CT, real_t >::value, bool >::type = true>
	Vector (std::initializer_list< CT > values)
	Create a vector using a braced initializer list.

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

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

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

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

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

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

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

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

void	Reserve (int res)
	Update Capacity() to res (if less than current), keeping existing entries.

void	DeleteAt (const Array< int > &indices)

void	SetData (real_t *d)

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

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

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

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

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

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

void	Destroy ()
	Destroy a vector.

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.

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

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

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

MFEM_DEPRECATED	operator real_t * ()
	Conversion to `double *`. Deprecated.

MFEM_DEPRECATED	operator const real_t * () const
	Conversion to `const double *`. Deprecated.

real_t *	begin ()
	STL-like begin.

real_t *	end ()
	STL-like end.

const real_t *	begin () const
	STL-like begin (const version).

const real_t *	end () const
	STL-like end (const version).

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

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

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

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

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

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

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

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

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

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

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

real_t &	operator[] (int i)
	Access Vector entries using [] for 0-based indexing.

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

real_t	operator* (const real_t *v) const

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

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

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

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

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

Vector &	operator*= (real_t c)

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

Vector &	operator/= (real_t c)

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

Vector &	operator-= (real_t c)

Vector &	operator-= (const Vector &v)

Vector &	operator+= (real_t c)

Vector &	operator+= (const Vector &v)

Vector &	Add (const real_t a, const Vector &Va)
	(this) += a Va

Vector &	Set (const real_t a, const Vector &x)
	(this) = a x

void	SetVector (const Vector &v, int offset)
	(*this)[i + offset] = v[i]

void	AddSubVector (const Vector &v, int offset)
	(*this)[i + offset] += v[i]

void	Neg ()
	(this) = -(this)

void	Reciprocal ()
	(this)(i) = 1.0 / (this)(i)

void	Abs ()
	(this)(i) = abs((this)(i))

void	Pow (const real_t p)
	(this)(i) = pow((this)(i), p)

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

void	cross3D (const Vector &vin, Vector &vout) const

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

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

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

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

void	SetSubVectorHost (const Array< int > &dofs, const real_t value)
	Set the entries listed in dofs to the given value (always on host).

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.

void	SetSubVector (const Array< int > &dofs, real_t *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.

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.

void	AddElementVector (const Array< int > &dofs, real_t *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.

void	AddElementVector (const Array< int > &dofs, const real_t 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*.

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

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

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.

void	PrintMathematica (std::ostream &out=mfem::out) const
	Prints vector as a List for importing into Mathematica.

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

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

real_t	Norml2 () const
	Returns the l2 norm of the vector.

real_t	Normlinf () const
	Returns the l_infinity norm of the vector.

real_t	Norml1 () const
	Returns the l_1 norm of the vector.

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

real_t	Max () const
	Returns the maximal element of the vector.

real_t	Min () const
	Returns the minimal element of the vector.

real_t	Sum () const
	Return the sum of the vector entries.

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

real_t	DistanceSquaredTo (const Vector &p) const
	Compute the square of the Euclidean distance to another vector.

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

real_t	DistanceTo (const Vector &p) const
	Compute the Euclidean distance to another vector.

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.

virtual	~Vector ()
	Destroys vector.

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

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

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

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

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

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

Protected Member Functions
void	Destroy ()

Protected Attributes
ParFiniteElementSpace *	pfes

FiniteElementCollection *	fec_owned
	Used when the grid function is read from a file. It can also be set explicitly, see MakeOwner().

long	fes_sequence

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

int	size

Detailed Description

Class for parallel complex-valued grid function - real + imaginary part Vector with associated parallel FE space.

Definition at line 424 of file complex_fem.hpp.

Constructor & Destructor Documentation

◆ ParComplexGridFunction() [1/2]

mfem::ParComplexGridFunction::ParComplexGridFunction ( ParFiniteElementSpace * pf )

Construct a ParComplexGridFunction associated with the ParFiniteElementSpace *pf.

Definition at line 774 of file complex_fem.cpp.

◆ ParComplexGridFunction() [2/2]

mfem::ParComplexGridFunction::ParComplexGridFunction	(	ParMesh *	pmesh,
		std::istream &	input )

Construct a ParComplexGridFunction on a given ParMesh, pmesh, reading from an std::istream.

In the process, a ParFiniteElementSpace and a FiniteElementCollection are constructed. The new ParComplexGridFunction assumes ownership of both.

Definition at line 789 of file complex_fem.cpp.

◆ ~ParComplexGridFunction()

virtual mfem::ParComplexGridFunction::~ParComplexGridFunction ( )

inlinevirtual

Destroys grid function.

Definition at line 568 of file complex_fem.hpp.

Member Function Documentation

◆ ComputeL2Error() [1/2]

virtual real_t mfem::ParComplexGridFunction::ComputeL2Error	(	Coefficient &	exsolr,
		Coefficient &	exsoli,
		const IntegrationRule *	irs[] = NULL,
		Array< int > *	elems = NULL ) const

inlinevirtual

Returns ||u_ex - u_h||_L2 in parallel for complex-valued scalar fields.

See also: GridFunction::ComputeL2Error(Coefficient &exsol, const IntegrationRule *irs[], const Array<int> *elems) const for more detailed documentation.

Definition at line 530 of file complex_fem.hpp.

◆ ComputeL2Error() [2/2]

virtual real_t mfem::ParComplexGridFunction::ComputeL2Error	(	VectorCoefficient &	exsolr,
		VectorCoefficient &	exsoli,
		const IntegrationRule *	irs[] = NULL,
		Array< int > *	elems = NULL ) const

inlinevirtual

Returns ||u_ex - u_h||_L2 in parallel for complex-valued vector fields.

See also: GridFunction::ComputeL2Error(VectorCoefficient &exsol, const IntegrationRule *irs[], const Array<int> *elems) const for more detailed documentation.

Definition at line 546 of file complex_fem.hpp.

◆ Destroy()

void mfem::ParComplexGridFunction::Destroy ( )

protected

Definition at line 863 of file complex_fem.cpp.

◆ Distribute() [1/2]

void mfem::ParComplexGridFunction::Distribute ( const Vector & tv )

inline

Definition at line 498 of file complex_fem.hpp.

◆ Distribute() [2/2]

void mfem::ParComplexGridFunction::Distribute ( const Vector * tv )

Definition at line 1011 of file complex_fem.cpp.

◆ FESpace() [1/2]

FiniteElementSpace * mfem::ParComplexGridFunction::FESpace ( )

inline

Definition at line 503 of file complex_fem.hpp.

◆ FESpace() [2/2]

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

inline

Definition at line 504 of file complex_fem.hpp.

◆ GetSequence()

long mfem::ParComplexGridFunction::GetSequence ( ) const

inline

Return update counter, similar to Mesh::GetSequence(). Used to check if it is up to date with the space.

Definition at line 462 of file complex_fem.hpp.

◆ imag() [1/2]

ParGridFunction & mfem::ParComplexGridFunction::imag ( )

inline

Definition at line 510 of file complex_fem.hpp.

◆ imag() [2/2]

const ParGridFunction & mfem::ParComplexGridFunction::imag ( ) const

inline

Definition at line 512 of file complex_fem.hpp.

◆ MakeOwner()

void mfem::ParComplexGridFunction::MakeOwner ( FiniteElementCollection * fec_ )

inline

Make the ParComplexGridFunction the owner of fec_owned and pfes.

If the new FiniteElementCollection, fec_, is NULL, ownership of fec_owned and pfes is taken away.

Definition at line 467 of file complex_fem.hpp.

◆ operator=()

ParComplexGridFunction & mfem::ParComplexGridFunction::operator= ( const std::complex< real_t > & value )

inline

Assign constant values to the ParComplexGridFunction data.

Definition at line 479 of file complex_fem.hpp.

◆ OwnFEC()

FiniteElementCollection * mfem::ParComplexGridFunction::OwnFEC ( )

inline

Returns a pointer to the FiniteElementCollection used to construct this ParComplexGridFunction if this class owns that object. Otherwise this function will return NULL.

Definition at line 472 of file complex_fem.hpp.

◆ ParallelProject()

void mfem::ParComplexGridFunction::ParallelProject ( Vector & tv ) const

Returns the vector restricted to the true dofs.

Definition at line 1028 of file complex_fem.cpp.

◆ ParFESpace() [1/2]

ParFiniteElementSpace * mfem::ParComplexGridFunction::ParFESpace ( )

inline

Definition at line 506 of file complex_fem.hpp.

◆ ParFESpace() [2/2]

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

inline

Definition at line 507 of file complex_fem.hpp.

◆ ProjectBdrCoefficient()

void mfem::ParComplexGridFunction::ProjectBdrCoefficient	(	Coefficient &	real_coeff,
		Coefficient &	imag_coeff,
		Array< int > &	attr )

virtual

Definition at line 968 of file complex_fem.cpp.

◆ ProjectBdrCoefficientNormal()

void mfem::ParComplexGridFunction::ProjectBdrCoefficientNormal	(	VectorCoefficient &	real_coeff,
		VectorCoefficient &	imag_coeff,
		Array< int > &	attr )

virtual

Definition at line 981 of file complex_fem.cpp.

◆ ProjectBdrCoefficientTangent()

void mfem::ParComplexGridFunction::ProjectBdrCoefficientTangent	(	VectorCoefficient &	real_coeff,
		VectorCoefficient &	imag_coeff,
		Array< int > &	attr )

virtual

Definition at line 996 of file complex_fem.cpp.

◆ ProjectCoefficient() [1/2]

void mfem::ParComplexGridFunction::ProjectCoefficient	(	Coefficient &	real_coeff,
		Coefficient &	imag_coeff )

virtual

Definition at line 944 of file complex_fem.cpp.

◆ ProjectCoefficient() [2/2]

void mfem::ParComplexGridFunction::ProjectCoefficient	(	VectorCoefficient &	real_vcoeff,
		VectorCoefficient &	imag_vcoeff )

virtual

Definition at line 956 of file complex_fem.cpp.

◆ real() [1/2]

ParGridFunction & mfem::ParComplexGridFunction::real ( )

inline

Definition at line 509 of file complex_fem.hpp.

◆ real() [2/2]

const ParGridFunction & mfem::ParComplexGridFunction::real ( ) const

inline

Definition at line 511 of file complex_fem.hpp.

◆ Save() [1/2]

void mfem::ParComplexGridFunction::Save	(	const char *	fname,
		int	precision = 16 ) const

Save the ParComplexGridFunction to files.

Saves one file for each MPI rank. The files will be given suffixes according to the MPI rank. The given precision will be used for ASCII output.

Definition at line 1085 of file complex_fem.cpp.

◆ Save() [2/2]

void mfem::ParComplexGridFunction::Save ( std::ostream & out ) const

Save the local portion of the ParComplexGridFunction.

This differs from the serial ComplexGridFunction::Save in that it takes into account the signs of the local dofs.

Definition at line 1047 of file complex_fem.cpp.

◆ Sync()

void mfem::ParComplexGridFunction::Sync ( )

inline

Update the memory location of the real and imaginary ParGridFunction pgfr and pgfi to match the ParComplexGridFunction.

Definition at line 516 of file complex_fem.hpp.

◆ SyncAlias()

void mfem::ParComplexGridFunction::SyncAlias ( )

inline

Update the alias memory location of the real and imaginary ParGridFunction pgfr and pgfi to match the ParComplexGridFunction.

Definition at line 520 of file complex_fem.hpp.

◆ Update()

void mfem::ParComplexGridFunction::Update ( )

Definition at line 876 of file complex_fem.cpp.

◆ VectorDim()

int mfem::ParComplexGridFunction::VectorDim ( ) const

Shortcut for calling FiniteElementSpace::GetVectorDim() on the underlying pfes

Definition at line 932 of file complex_fem.cpp.

Member Data Documentation

◆ fec_owned

FiniteElementCollection* mfem::ParComplexGridFunction::fec_owned

protected

Used when the grid function is read from a file. It can also be set explicitly, see MakeOwner().

If not NULL, this pointer is owned by the ParComplexGridFunction.

Definition at line 439 of file complex_fem.hpp.

◆ fes_sequence

long mfem::ParComplexGridFunction::fes_sequence

protected

Definition at line 441 of file complex_fem.hpp.

◆ pfes

ParFiniteElementSpace* mfem::ParComplexGridFunction::pfes

protected

FE space on which the grid function lives. Owned if fec_owned is not NULL.

Definition at line 433 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 Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ParComplexGridFunction() [1/2]

◆ ParComplexGridFunction() [2/2]

◆ ~ParComplexGridFunction()

Member Function Documentation

◆ ComputeL2Error() [1/2]

◆ ComputeL2Error() [2/2]

◆ Destroy()

◆ Distribute() [1/2]

◆ Distribute() [2/2]

◆ FESpace() [1/2]

◆ FESpace() [2/2]

◆ GetSequence()

◆ imag() [1/2]

◆ imag() [2/2]

◆ MakeOwner()

◆ operator=()

◆ OwnFEC()

◆ ParallelProject()

◆ ParFESpace() [1/2]

◆ ParFESpace() [2/2]

◆ ProjectBdrCoefficient()

◆ ProjectBdrCoefficientNormal()

◆ ProjectBdrCoefficientTangent()

◆ ProjectCoefficient() [1/2]

◆ ProjectCoefficient() [2/2]

◆ real() [1/2]

◆ real() [2/2]

◆ Save() [1/2]

◆ Save() [2/2]

◆ Sync()

◆ SyncAlias()

◆ Update()

◆ VectorDim()

Member Data Documentation

◆ fec_owned

◆ fes_sequence

◆ pfes