MFEM  v4.1.0
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Protected Attributes | List of all members
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 f, using the same integrators as the LinearForms lfr (real) and lfi (imag) . More...
 
virtual ~ComplexLinearForm ()
 
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...
 
FiniteElementSpaceFESpace () const
 
LinearFormreal ()
 
LinearFormimag ()
 
const LinearFormreal () const
 
const LinearFormimag () const
 
void Update ()
 
void Update (FiniteElementSpace *f)
 
void Assemble ()
 Assembles the linear form i.e. sums over all domain/bdr integrators. More...
 
std::complex< double > operator() (const ComplexGridFunction &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...
 
Vectoroperator= (const double *v)
 Copy Size() entries from v. More...
 
Vectoroperator= (const Vector &v)
 Copy assignment. More...
 
Vectoroperator= (double value)
 Redefine '=' for vector = constant. More...
 
Vectoroperator*= (double c)
 
Vectoroperator/= (double c)
 
Vectoroperator-= (double c)
 
Vectoroperator-= (const Vector &v)
 
Vectoroperator+= (const Vector &v)
 
VectorAdd (const double a, const Vector &Va)
 (*this) += a * Va More...
 
VectorSet (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 Attributes

LinearFormlfr
 
LinearFormlfi
 
- Protected Attributes inherited from mfem::Vector
Memory< double > data
 
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 88 of file complex_fem.hpp.

Constructor & Destructor Documentation

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

Definition at line 121 of file complex_fem.cpp.

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

Create a ComplexLinearForm on the FiniteElementSpace f, using the same integrators as the LinearForms lfr (real) and lfi (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 130 of file complex_fem.cpp.

mfem::ComplexLinearForm::~ComplexLinearForm ( )
virtual

Definition at line 140 of file complex_fem.cpp.

Member Function Documentation

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

Adds new Boundary Face Integrator. Assumes ownership of lfi.

Definition at line 172 of file complex_fem.cpp.

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 180 of file complex_fem.cpp.

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

Adds new Boundary Integrator.

Definition at line 155 of file complex_fem.cpp.

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 163 of file complex_fem.cpp.

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

Adds new Domain Integrator.

Definition at line 147 of file complex_fem.cpp.

void mfem::ComplexLinearForm::Assemble ( )

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

Definition at line 210 of file complex_fem.cpp.

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

Definition at line 153 of file complex_fem.hpp.

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

Definition at line 115 of file complex_fem.hpp.

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

Definition at line 156 of file complex_fem.hpp.

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

Definition at line 158 of file complex_fem.hpp.

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

Definition at line 221 of file complex_fem.cpp.

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

Definition at line 155 of file complex_fem.hpp.

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

Definition at line 157 of file complex_fem.hpp.

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

Definition at line 116 of file complex_fem.hpp.

void mfem::ComplexLinearForm::Update ( )

Definition at line 189 of file complex_fem.cpp.

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

Definition at line 197 of file complex_fem.cpp.

Member Data Documentation

LinearForm* mfem::ComplexLinearForm::lfi
protected

Definition at line 95 of file complex_fem.hpp.

LinearForm* mfem::ComplexLinearForm::lfr
protected

Definition at line 94 of file complex_fem.hpp.


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