MFEM v4.7.0
Finite element discretization library
Loading...
Searching...
No Matches
mfem::ComplexLinearForm Class Reference

#include <complex_fem.hpp>

Inheritance diagram for mfem::ComplexLinearForm:
[legend]
Collaboration diagram for mfem::ComplexLinearForm:
[legend]

Public Member Functions

 ComplexLinearForm (FiniteElementSpace *fes, ComplexOperator::Convention convention=ComplexOperator::HERMITIAN)
 
 ComplexLinearForm (FiniteElementSpace *fes, LinearForm *lf_r, LinearForm *lf_i, ComplexOperator::Convention convention=ComplexOperator::HERMITIAN)
 Create a ComplexLinearForm on the FiniteElementSpace fes, using the same integrators as the LinearForms lf_r (real) and lf_i (imag).
 
virtual ~ComplexLinearForm ()
 
ComplexOperator::Convention GetConvention () const
 
void SetConvention (const ComplexOperator::Convention &convention)
 
void AddDomainIntegrator (LinearFormIntegrator *lfi_real, LinearFormIntegrator *lfi_imag)
 Adds new Domain Integrator.
 
void AddDomainIntegrator (LinearFormIntegrator *lfi_real, LinearFormIntegrator *lfi_imag, Array< int > &elem_attr_marker)
 Adds new Domain Integrator, restricted to the given attributes.
 
void AddBoundaryIntegrator (LinearFormIntegrator *lfi_real, LinearFormIntegrator *lfi_imag)
 Adds new Boundary Integrator.
 
void AddBoundaryIntegrator (LinearFormIntegrator *lfi_real, LinearFormIntegrator *lfi_imag, Array< int > &bdr_attr_marker)
 Add new Boundary Integrator, restricted to the given boundary attributes.
 
void AddBdrFaceIntegrator (LinearFormIntegrator *lfi_real, LinearFormIntegrator *lfi_imag)
 Adds new Boundary Face Integrator. Assumes ownership of lfi.
 
void AddBdrFaceIntegrator (LinearFormIntegrator *lfi_real, LinearFormIntegrator *lfi_imag, Array< int > &bdr_attr_marker)
 Add new Boundary Face Integrator, restricted to the given boundary attributes.
 
FiniteElementSpaceFESpace () const
 
LinearFormreal ()
 
LinearFormimag ()
 
const LinearFormreal () const
 
const LinearFormimag () const
 
void Sync ()
 
void SyncAlias ()
 
void Update ()
 
void Update (FiniteElementSpace *f)
 
void Assemble ()
 Assembles the linear form i.e. sums over all domain/bdr integrators.
 
std::complex< real_toperator() (const ComplexGridFunction &gf) const
 
- 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<int N, typename T = real_t>
 Vector (const T(&values)[N])
 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 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_tGetData () 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_tbegin ()
 STL-like begin.
 
real_tend ()
 STL-like end.
 
const real_tbegin () const
 STL-like begin (const version).
 
const real_tend () 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_tStealData ()
 Changes the ownership of the data; after the call the Vector is empty.
 
real_tElem (int i)
 Access Vector entries. Index i = 0 .. size-1.
 
const real_tElem (int i) const
 Read only access to Vector entries. Index i = 0 .. size-1.
 
real_toperator() (int i)
 Access Vector entries using () for 0-based indexing.
 
const real_toperator() (int i) const
 Read only access to Vector entries using () for 0-based indexing.
 
real_toperator[] (int i)
 Access Vector entries using [] for 0-based indexing.
 
const real_toperator[] (int i) const
 Read only access to Vector entries using [] for 0-based indexing.
 
real_t operator* (const real_t *) const
 Dot product with a double * array.
 
real_t operator* (const Vector &v) const
 Return the inner-product.
 
Vectoroperator= (const real_t *v)
 Copy Size() entries from v.
 
Vectoroperator= (const Vector &v)
 Copy assignment.
 
Vectoroperator= (Vector &&v)
 Move assignment.
 
Vectoroperator= (real_t value)
 Redefine '=' for vector = constant.
 
Vectoroperator*= (real_t c)
 
Vectoroperator*= (const Vector &v)
 Component-wise scaling: (*this)(i) *= v(i)
 
Vectoroperator/= (real_t c)
 
Vectoroperator/= (const Vector &v)
 Component-wise division: (*this)(i) /= v(i)
 
Vectoroperator-= (real_t c)
 
Vectoroperator-= (const Vector &v)
 
Vectoroperator+= (real_t c)
 
Vectoroperator+= (const Vector &v)
 
VectorAdd (const real_t a, const Vector &Va)
 (*this) += a * Va
 
VectorSet (const real_t a, const Vector &x)
 (*this) = a * x
 
void SetVector (const Vector &v, int offset)
 
void AddSubVector (const Vector &v, int offset)
 
void Neg ()
 (*this) = -(*this)
 
void Reciprocal ()
 (*this)(i) = 1.0 / (*this)(i)
 
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 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 -a*val 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 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_tRead (bool on_dev=true) const
 Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), on_dev).
 
virtual const real_tHostRead () const
 Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), false).
 
virtual real_tWrite (bool on_dev=true)
 Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), on_dev).
 
virtual real_tHostWrite ()
 Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), false).
 
virtual real_tReadWrite (bool on_dev=true)
 Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), on_dev).
 
virtual real_tHostReadWrite ()
 Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), false).
 

Protected Attributes

LinearFormlfr
 
LinearFormlfi
 
- Protected Attributes inherited from mfem::Vector
Memory< real_tdata
 
int size
 

Detailed Description

Class for a complex-valued 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 ComplexLinearForm 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 96 of file complex_fem.hpp.

Constructor & Destructor Documentation

◆ ComplexLinearForm() [1/2]

mfem::ComplexLinearForm::ComplexLinearForm ( FiniteElementSpace * fes,
ComplexOperator::Convention convention = ComplexOperator::HERMITIAN )

Definition at line 153 of file complex_fem.cpp.

◆ ComplexLinearForm() [2/2]

mfem::ComplexLinearForm::ComplexLinearForm ( FiniteElementSpace * fes,
LinearForm * lf_r,
LinearForm * lf_i,
ComplexOperator::Convention convention = ComplexOperator::HERMITIAN )

Create a ComplexLinearForm on the FiniteElementSpace fes, using the same integrators as the LinearForms lf_r (real) and lf_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 ComplexLinearForm.

Definition at line 168 of file complex_fem.cpp.

◆ ~ComplexLinearForm()

mfem::ComplexLinearForm::~ComplexLinearForm ( )
virtual

Definition at line 184 of file complex_fem.cpp.

Member Function Documentation

◆ AddBdrFaceIntegrator() [1/2]

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

Adds new Boundary Face Integrator. Assumes ownership of lfi.

Definition at line 225 of file complex_fem.cpp.

◆ AddBdrFaceIntegrator() [2/2]

void mfem::ComplexLinearForm::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 233 of file complex_fem.cpp.

◆ AddBoundaryIntegrator() [1/2]

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

Adds new Boundary Integrator.

Definition at line 208 of file complex_fem.cpp.

◆ AddBoundaryIntegrator() [2/2]

void mfem::ComplexLinearForm::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 216 of file complex_fem.cpp.

◆ AddDomainIntegrator() [1/2]

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

Adds new Domain Integrator.

Definition at line 191 of file complex_fem.cpp.

◆ AddDomainIntegrator() [2/2]

void mfem::ComplexLinearForm::AddDomainIntegrator ( LinearFormIntegrator * lfi_real,
LinearFormIntegrator * lfi_imag,
Array< int > & elem_attr_marker )

Adds new Domain Integrator, restricted to the given attributes.

Definition at line 199 of file complex_fem.cpp.

◆ Assemble()

void mfem::ComplexLinearForm::Assemble ( )

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

Definition at line 260 of file complex_fem.cpp.

◆ FESpace()

FiniteElementSpace * mfem::ComplexLinearForm::FESpace ( ) const
inline

Definition at line 166 of file complex_fem.hpp.

◆ GetConvention()

ComplexOperator::Convention mfem::ComplexLinearForm::GetConvention ( ) const
inline

Definition at line 123 of file complex_fem.hpp.

◆ imag() [1/2]

LinearForm & mfem::ComplexLinearForm::imag ( )
inline

Definition at line 169 of file complex_fem.hpp.

◆ imag() [2/2]

const LinearForm & mfem::ComplexLinearForm::imag ( ) const
inline

Definition at line 171 of file complex_fem.hpp.

◆ operator()()

complex< real_t > mfem::ComplexLinearForm::operator() ( const ComplexGridFunction & gf) const

Definition at line 272 of file complex_fem.cpp.

◆ real() [1/2]

LinearForm & mfem::ComplexLinearForm::real ( )
inline

Definition at line 168 of file complex_fem.hpp.

◆ real() [2/2]

const LinearForm & mfem::ComplexLinearForm::real ( ) const
inline

Definition at line 170 of file complex_fem.hpp.

◆ SetConvention()

void mfem::ComplexLinearForm::SetConvention ( const ComplexOperator::Convention & convention)
inline

Definition at line 124 of file complex_fem.hpp.

◆ Sync()

void mfem::ComplexLinearForm::Sync ( )
inline

Update the memory location of the real and imaginary LinearForm lfr and lfi to match the ComplexLinearForm.

Definition at line 175 of file complex_fem.hpp.

◆ SyncAlias()

void mfem::ComplexLinearForm::SyncAlias ( )
inline

Update the alias memory location of the real and imaginary LinearForm lfr and lfi to match the ComplexLinearForm.

Definition at line 179 of file complex_fem.hpp.

◆ Update() [1/2]

void mfem::ComplexLinearForm::Update ( )

Definition at line 242 of file complex_fem.cpp.

◆ Update() [2/2]

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

Definition at line 249 of file complex_fem.cpp.

Member Data Documentation

◆ lfi

LinearForm* mfem::ComplexLinearForm::lfi
protected

Definition at line 103 of file complex_fem.hpp.

◆ lfr

LinearForm* mfem::ComplexLinearForm::lfr
protected

Definition at line 102 of file complex_fem.hpp.


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