MFEM  v4.6.0
Finite element discretization library
Public Member Functions | List of all members
mfem::ParSesquilinearForm Class Reference

#include <complex_fem.hpp>

Public Member Functions

 ParSesquilinearForm (ParFiniteElementSpace *pf, ComplexOperator::Convention convention=ComplexOperator::HERMITIAN)
 
 ParSesquilinearForm (ParFiniteElementSpace *pf, ParBilinearForm *pbfr, ParBilinearForm *pbfi, ComplexOperator::Convention convention=ComplexOperator::HERMITIAN)
 Create a ParSesquilinearForm on the ParFiniteElementSpace pf, using the same integrators as the ParBilinearForms pbfr and pbfi . More...
 
ComplexOperator::Convention GetConvention () const
 
void SetConvention (const ComplexOperator::Convention &convention)
 
void SetAssemblyLevel (AssemblyLevel assembly_level)
 Set the desired assembly level. More...
 
ParBilinearFormreal ()
 
ParBilinearFormimag ()
 
const ParBilinearFormreal () const
 
const ParBilinearFormimag () const
 
void AddDomainIntegrator (BilinearFormIntegrator *bfi_real, BilinearFormIntegrator *bfi_imag)
 Adds new Domain Integrator. More...
 
void AddDomainIntegrator (BilinearFormIntegrator *bfi_real, BilinearFormIntegrator *bfi_imag, Array< int > &elem_marker)
 Adds new Domain Integrator, restricted to specific attributes. More...
 
void AddBoundaryIntegrator (BilinearFormIntegrator *bfi_real, BilinearFormIntegrator *bfi_imag)
 Adds new Boundary Integrator. More...
 
void AddBoundaryIntegrator (BilinearFormIntegrator *bfi_real, BilinearFormIntegrator *bfi_imag, Array< int > &bdr_marker)
 Adds new boundary Integrator, restricted to specific boundary attributes. More...
 
void AddInteriorFaceIntegrator (BilinearFormIntegrator *bfi_real, BilinearFormIntegrator *bfi_imag)
 Adds new interior Face Integrator. Assumes ownership of bfi. More...
 
void AddBdrFaceIntegrator (BilinearFormIntegrator *bfi_real, BilinearFormIntegrator *bfi_imag)
 Adds new boundary Face Integrator. Assumes ownership of bfi. More...
 
void AddBdrFaceIntegrator (BilinearFormIntegrator *bfi_real, BilinearFormIntegrator *bfi_imag, Array< int > &bdr_marker)
 Adds new boundary Face Integrator, restricted to specific boundary attributes. More...
 
void Assemble (int skip_zeros=1)
 Assemble the local matrix. More...
 
void Finalize (int skip_zeros=1)
 Finalizes the matrix initialization. More...
 
ComplexHypreParMatrixParallelAssemble ()
 Returns the matrix assembled on the true dofs, i.e. P^t A P. More...
 
ParFiniteElementSpaceParFESpace () const
 Return the parallel FE space associated with the ParBilinearForm. More...
 
void FormLinearSystem (const Array< int > &ess_tdof_list, Vector &x, Vector &b, OperatorHandle &A, Vector &X, Vector &B, int copy_interior=0)
 
void FormSystemMatrix (const Array< int > &ess_tdof_list, OperatorHandle &A)
 
virtual void RecoverFEMSolution (const Vector &X, const Vector &b, Vector &x)
 
virtual void Update (FiniteElementSpace *nfes=NULL)
 
virtual ~ParSesquilinearForm ()
 

Detailed Description

Class for a parallel sesquilinear form

A sesquilinear form is a generalization of a bilinear form to complex-valued fields. Sesquilinear forms are linear in the second argument but the first argument involves a complex conjugate in the sense that:

        a(alpha u, beta v) = conj(alpha) beta a(u, v)

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 ParSesquilinearForm either the real or imaginary integrator can be NULL. This indicates that the corresponding portion of the complex-valued material coefficient is equal to zero.

Definition at line 557 of file complex_fem.hpp.

Constructor & Destructor Documentation

◆ ParSesquilinearForm() [1/2]

mfem::ParSesquilinearForm::ParSesquilinearForm ( ParFiniteElementSpace pf,
ComplexOperator::Convention  convention = ComplexOperator::HERMITIAN 
)

Definition at line 1039 of file complex_fem.cpp.

◆ ParSesquilinearForm() [2/2]

mfem::ParSesquilinearForm::ParSesquilinearForm ( ParFiniteElementSpace pf,
ParBilinearForm pbfr,
ParBilinearForm pbfi,
ComplexOperator::Convention  convention = ComplexOperator::HERMITIAN 
)

Create a ParSesquilinearForm on the ParFiniteElementSpace pf, using the same integrators as the ParBilinearForms pbfr and pbfi .

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

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

Definition at line 1047 of file complex_fem.cpp.

◆ ~ParSesquilinearForm()

mfem::ParSesquilinearForm::~ParSesquilinearForm ( )
virtual

Definition at line 1056 of file complex_fem.cpp.

Member Function Documentation

◆ AddBdrFaceIntegrator() [1/2]

void mfem::ParSesquilinearForm::AddBdrFaceIntegrator ( BilinearFormIntegrator bfi_real,
BilinearFormIntegrator bfi_imag 
)

Adds new boundary Face Integrator. Assumes ownership of bfi.

Definition at line 1103 of file complex_fem.cpp.

◆ AddBdrFaceIntegrator() [2/2]

void mfem::ParSesquilinearForm::AddBdrFaceIntegrator ( BilinearFormIntegrator bfi_real,
BilinearFormIntegrator bfi_imag,
Array< int > &  bdr_marker 
)

Adds new boundary Face Integrator, restricted to specific boundary attributes.

Assumes ownership of bfi.

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

Definition at line 1111 of file complex_fem.cpp.

◆ AddBoundaryIntegrator() [1/2]

void mfem::ParSesquilinearForm::AddBoundaryIntegrator ( BilinearFormIntegrator bfi_real,
BilinearFormIntegrator bfi_imag 
)

Adds new Boundary Integrator.

Definition at line 1078 of file complex_fem.cpp.

◆ AddBoundaryIntegrator() [2/2]

void mfem::ParSesquilinearForm::AddBoundaryIntegrator ( BilinearFormIntegrator bfi_real,
BilinearFormIntegrator bfi_imag,
Array< int > &  bdr_marker 
)

Adds new boundary Integrator, restricted to specific boundary attributes.

Assumes ownership of bfi.

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

Definition at line 1086 of file complex_fem.cpp.

◆ AddDomainIntegrator() [1/2]

void mfem::ParSesquilinearForm::AddDomainIntegrator ( BilinearFormIntegrator bfi_real,
BilinearFormIntegrator bfi_imag 
)

Adds new Domain Integrator.

Definition at line 1062 of file complex_fem.cpp.

◆ AddDomainIntegrator() [2/2]

void mfem::ParSesquilinearForm::AddDomainIntegrator ( BilinearFormIntegrator bfi_real,
BilinearFormIntegrator bfi_imag,
Array< int > &  elem_marker 
)

Adds new Domain Integrator, restricted to specific attributes.

Definition at line 1069 of file complex_fem.cpp.

◆ AddInteriorFaceIntegrator()

void mfem::ParSesquilinearForm::AddInteriorFaceIntegrator ( BilinearFormIntegrator bfi_real,
BilinearFormIntegrator bfi_imag 
)

Adds new interior Face Integrator. Assumes ownership of bfi.

Definition at line 1095 of file complex_fem.cpp.

◆ Assemble()

void mfem::ParSesquilinearForm::Assemble ( int  skip_zeros = 1)

Assemble the local matrix.

Definition at line 1120 of file complex_fem.cpp.

◆ Finalize()

void mfem::ParSesquilinearForm::Finalize ( int  skip_zeros = 1)

Finalizes the matrix initialization.

Definition at line 1127 of file complex_fem.cpp.

◆ FormLinearSystem()

void mfem::ParSesquilinearForm::FormLinearSystem ( const Array< int > &  ess_tdof_list,
Vector x,
Vector b,
OperatorHandle A,
Vector X,
Vector B,
int  copy_interior = 0 
)

Definition at line 1142 of file complex_fem.cpp.

◆ FormSystemMatrix()

void mfem::ParSesquilinearForm::FormSystemMatrix ( const Array< int > &  ess_tdof_list,
OperatorHandle A 
)

Definition at line 1317 of file complex_fem.cpp.

◆ GetConvention()

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

Definition at line 587 of file complex_fem.hpp.

◆ imag() [1/2]

ParBilinearForm& mfem::ParSesquilinearForm::imag ( )
inline

Definition at line 608 of file complex_fem.hpp.

◆ imag() [2/2]

const ParBilinearForm& mfem::ParSesquilinearForm::imag ( ) const
inline

Definition at line 610 of file complex_fem.hpp.

◆ ParallelAssemble()

ComplexHypreParMatrix * mfem::ParSesquilinearForm::ParallelAssemble ( )

Returns the matrix assembled on the true dofs, i.e. P^t A P.

The returned matrix has to be deleted by the caller.

Definition at line 1134 of file complex_fem.cpp.

◆ ParFESpace()

ParFiniteElementSpace* mfem::ParSesquilinearForm::ParFESpace ( ) const
inline

Return the parallel FE space associated with the ParBilinearForm.

Definition at line 666 of file complex_fem.hpp.

◆ real() [1/2]

ParBilinearForm& mfem::ParSesquilinearForm::real ( )
inline

Definition at line 607 of file complex_fem.hpp.

◆ real() [2/2]

const ParBilinearForm& mfem::ParSesquilinearForm::real ( ) const
inline

Definition at line 609 of file complex_fem.hpp.

◆ RecoverFEMSolution()

void mfem::ParSesquilinearForm::RecoverFEMSolution ( const Vector X,
const Vector b,
Vector x 
)
virtual

Call this method after solving a linear system constructed using the FormLinearSystem method to recover the solution as a ParGridFunction-size vector in x. Use the same arguments as in the FormLinearSystem call.

Definition at line 1385 of file complex_fem.cpp.

◆ SetAssemblyLevel()

void mfem::ParSesquilinearForm::SetAssemblyLevel ( AssemblyLevel  assembly_level)
inline

Set the desired assembly level.

Valid choices are:

This method must be called before assembly.

Definition at line 601 of file complex_fem.hpp.

◆ SetConvention()

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

Definition at line 588 of file complex_fem.hpp.

◆ Update()

void mfem::ParSesquilinearForm::Update ( FiniteElementSpace nfes = NULL)
virtual

Definition at line 1412 of file complex_fem.cpp.


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