MFEM  v4.1.0
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Protected Member Functions | List of all members
mfem::ComplexGridFunction Class Reference

#include <complex_fem.hpp>

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

Public Member Functions

 ComplexGridFunction (FiniteElementSpace *f)
 
void Update ()
 
ComplexGridFunctionoperator= (const std::complex< double > &value)
 Assign constant values to the ComplexGridFunction data. More...
 
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)
 
FiniteElementSpaceFESpace ()
 
const FiniteElementSpaceFESpace () const
 
GridFunctionreal ()
 
GridFunctionimag ()
 
const GridFunctionreal () const
 
const GridFunctionimag () const
 
virtual ~ComplexGridFunction ()
 Destroys the grid function. More...
 
- 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 Member Functions

void Destroy ()
 

Additional Inherited Members

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

Detailed Description

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

Definition at line 31 of file complex_fem.hpp.

Constructor & Destructor Documentation

mfem::ComplexGridFunction::ComplexGridFunction ( FiniteElementSpace f)

Definition at line 19 of file complex_fem.cpp.

virtual mfem::ComplexGridFunction::~ComplexGridFunction ( )
inlinevirtual

Destroys the grid function.

Definition at line 75 of file complex_fem.hpp.

Member Function Documentation

void mfem::ComplexGridFunction::Destroy ( )
inlineprotected

Definition at line 38 of file complex_fem.hpp.

FiniteElementSpace* mfem::ComplexGridFunction::FESpace ( )
inline

Definition at line 66 of file complex_fem.hpp.

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

Definition at line 67 of file complex_fem.hpp.

GridFunction& mfem::ComplexGridFunction::imag ( )
inline

Definition at line 70 of file complex_fem.hpp.

const GridFunction& mfem::ComplexGridFunction::imag ( ) const
inline

Definition at line 72 of file complex_fem.hpp.

ComplexGridFunction& mfem::ComplexGridFunction::operator= ( const std::complex< double > &  value)
inline

Assign constant values to the ComplexGridFunction data.

Definition at line 48 of file complex_fem.hpp.

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

Definition at line 92 of file complex_fem.cpp.

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

Definition at line 101 of file complex_fem.cpp.

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

Definition at line 110 of file complex_fem.cpp.

void mfem::ComplexGridFunction::ProjectCoefficient ( Coefficient real_coeff,
Coefficient imag_coeff 
)
virtual

Definition at line 76 of file complex_fem.cpp.

void mfem::ComplexGridFunction::ProjectCoefficient ( VectorCoefficient real_vcoeff,
VectorCoefficient imag_vcoeff 
)
virtual

Definition at line 84 of file complex_fem.cpp.

GridFunction& mfem::ComplexGridFunction::real ( )
inline

Definition at line 69 of file complex_fem.hpp.

const GridFunction& mfem::ComplexGridFunction::real ( ) const
inline

Definition at line 71 of file complex_fem.hpp.

void mfem::ComplexGridFunction::Update ( )

Definition at line 27 of file complex_fem.cpp.


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