MueLu
Version of the Day
|
Preconditioner (wrapped as a Xpetra::Operator) for Maxwell's equations in curl-curl form. More...
#include <MueLu_Maxwell1_decl.hpp>
Public Types | |
typedef Teuchos::ScalarTraits< Scalar >::magnitudeType | magnitudeType |
typedef Teuchos::ScalarTraits< Scalar >::coordinateType | coordinateType |
typedef Xpetra::MultiVector< coordinateType, LO, GO, NO > | RealValuedMultiVector |
Public Member Functions | |
Maxwell1 () | |
Constructor. More... | |
Maxwell1 (Teuchos::RCP< Hierarchy > H11, Teuchos::RCP< Hierarchy > H22) | |
Constructor with Hierarchies. More... | |
Maxwell1 (const Teuchos::RCP< Matrix > &SM_Matrix, const Teuchos::RCP< Matrix > &D0_Matrix, const Teuchos::RCP< MultiVector > &Nullspace, const Teuchos::RCP< RealValuedMultiVector > &Coords, Teuchos::ParameterList &List, bool ComputePrec=true) | |
Maxwell1 (const Teuchos::RCP< Matrix > &SM_Matrix, const Teuchos::RCP< Matrix > &D0_Matrix, const Teuchos::RCP< Matrix > &Kn_Matrix, const Teuchos::RCP< MultiVector > &Nullspace, const Teuchos::RCP< RealValuedMultiVector > &Coords, Teuchos::ParameterList &List, bool ComputePrec=true) | |
Maxwell1 (const Teuchos::RCP< Matrix > &SM_Matrix, Teuchos::ParameterList &List, bool ComputePrec=true) | |
virtual | ~Maxwell1 () |
Destructor. More... | |
Teuchos::RCP< const Map > | getDomainMap () const |
Returns the Xpetra::Map object associated with the domain of this operator. More... | |
Teuchos::RCP< const Map > | getRangeMap () const |
Returns the Xpetra::Map object associated with the range of this operator. More... | |
const Teuchos::RCP< Matrix > & | getJacobian () const |
Returns Jacobian matrix SM. More... | |
void | setParameters (Teuchos::ParameterList &list) |
Set parameters. More... | |
void | compute (bool reuse=false) |
Setup the preconditioner. More... | |
void | resetMatrix (Teuchos::RCP< Matrix > SM_Matrix_new, bool ComputePrec=true) |
Reset system matrix. More... | |
void | apply (const MultiVector &X, MultiVector &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=Teuchos::ScalarTraits< Scalar >::one(), Scalar beta=Teuchos::ScalarTraits< Scalar >::zero()) const |
bool | hasTransposeApply () const |
Indicates whether this operator supports applying the adjoint operator. More... | |
void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::VERB_HIGH) const |
void | residual (const MultiVector &X, const MultiVector &B, MultiVector &R) const |
Compute a residual R = B - (*this) * X. More... | |
![]() | |
VerbLevel | GetVerbLevel () const |
Get the verbosity level. More... | |
void | SetVerbLevel (const VerbLevel verbLevel) |
Set the verbosity level of this object. More... | |
int | GetProcRankVerbose () const |
Get proc rank used for printing. Do not use this information for any other purpose. More... | |
int | SetProcRankVerbose (int procRank) const |
Set proc rank used for printing. More... | |
bool | IsPrint (MsgType type, int thisProcRankOnly=-1) const |
Find out whether we need to print out information for a specific message type. More... | |
Teuchos::FancyOStream & | GetOStream (MsgType type, int thisProcRankOnly=0) const |
Get an output stream for outputting the input message type. More... | |
Teuchos::FancyOStream & | GetBlackHole () const |
VerboseObject () | |
virtual | ~VerboseObject () |
Destructor. More... | |
Private Types | |
enum | mode_type { MODE_STANDARD =0, MODE_REFMAXWELL, MODE_EDGE_ONLY } |
Execution modes. More... | |
Private Member Functions | |
Teuchos::RCP< Matrix > | generate_kn () const |
Generates the Kn matrix. More... | |
void | initialize (const Teuchos::RCP< Matrix > &D0_Matrix, const Teuchos::RCP< Matrix > &Kn_Matrix, const Teuchos::RCP< MultiVector > &Nullspace, const Teuchos::RCP< RealValuedMultiVector > &Coords, Teuchos::ParameterList &List) |
void | applyInverseRefMaxwellAdditive (const MultiVector &RHS, MultiVector &X) const |
apply RefMaxwell additive 2x2 style cycle More... | |
void | applyInverseStandard (const MultiVector &RHS, MultiVector &X) const |
apply standard Maxwell1 cycle More... | |
void | allocateMemory (int numVectors) const |
allocate multivectors for solve More... | |
void | dump (const Matrix &A, std::string name) const |
dump out matrix More... | |
void | dump (const MultiVector &X, std::string name) const |
dump out multivector More... | |
void | dumpCoords (const RealValuedMultiVector &X, std::string name) const |
dump out real-valued multivector More... | |
void | dump (const Teuchos::ArrayRCP< bool > &v, std::string name) const |
dump out boolean ArrayView More... | |
Teuchos::RCP< Teuchos::TimeMonitor > | getTimer (std::string name, RCP< const Teuchos::Comm< int > > comm=Teuchos::null) const |
get a (synced) timer More... | |
Private Attributes | |
Teuchos::ParameterList | parameterList_ |
ParameterLists. More... | |
Teuchos::ParameterList | precList11_ |
Teuchos::ParameterList | precList22_ |
Teuchos::RCP< Hierarchy > | Hierarchy11_ |
Two hierarchies: one for the (1,1)-block, another for the (2,2)-block. More... | |
Teuchos::RCP< Hierarchy > | Hierarchy22_ |
Teuchos::RCP< Matrix > | SM_Matrix_ |
Various matrices. More... | |
Teuchos::RCP< Matrix > | D0_Matrix_ |
Teuchos::RCP< Matrix > | Kn_Matrix_ |
int | BCedges_ |
Vectors for BCs. More... | |
int | BCnodes_ |
Teuchos::ArrayRCP< bool > | BCrows_ |
Teuchos::ArrayRCP< bool > | BCcols_ |
Teuchos::ArrayRCP< bool > | BCdomain_ |
Teuchos::RCP< MultiVector > | Nullspace_ |
Nullspace. More... | |
Teuchos::RCP< RealValuedMultiVector > | Coords_ |
Coordinates. More... | |
bool | useKokkos_ |
Some options. More... | |
bool | allEdgesBoundary_ |
bool | allNodesBoundary_ |
bool | dump_matrices_ |
bool | enable_reuse_ |
bool | syncTimers_ |
bool | applyBCsTo22_ |
mode_type | mode_ |
RCP< Matrix > | P11_ |
Temporary memory (cached vectors for RefMaxwell-style) More... | |
Teuchos::RCP< MultiVector > | residualFine_ |
Teuchos::RCP< MultiVector > | residual11c_ |
Teuchos::RCP< MultiVector > | residual22_ |
Teuchos::RCP< MultiVector > | update11c_ |
Teuchos::RCP< MultiVector > | update22_ |
Additional Inherited Members | |
![]() | |
static void | SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream) |
static void | SetMueLuOFileStream (const std::string &filename) |
static Teuchos::RCP< Teuchos::FancyOStream > | GetMueLuOStream () |
static void | SetDefaultVerbLevel (const VerbLevel defaultVerbLevel) |
Set the default (global) verbosity level. More... | |
static VerbLevel | GetDefaultVerbLevel () |
Get the default (global) verbosity level. More... | |
Preconditioner (wrapped as a Xpetra::Operator) for Maxwell's equations in curl-curl form.
Definition at line 87 of file MueLu_Maxwell1_decl.hpp.
typedef Teuchos::ScalarTraits<Scalar>::magnitudeType MueLu::Maxwell1< Scalar, LocalOrdinal, GlobalOrdinal, Node >::magnitudeType |
Definition at line 94 of file MueLu_Maxwell1_decl.hpp.
typedef Teuchos::ScalarTraits<Scalar>::coordinateType MueLu::Maxwell1< Scalar, LocalOrdinal, GlobalOrdinal, Node >::coordinateType |
Definition at line 95 of file MueLu_Maxwell1_decl.hpp.
typedef Xpetra::MultiVector<coordinateType,LO,GO,NO> MueLu::Maxwell1< Scalar, LocalOrdinal, GlobalOrdinal, Node >::RealValuedMultiVector |
Definition at line 96 of file MueLu_Maxwell1_decl.hpp.
|
private |
Execution modes.
Enumerator | |
---|---|
MODE_STANDARD | |
MODE_REFMAXWELL | |
MODE_EDGE_ONLY |
Definition at line 298 of file MueLu_Maxwell1_decl.hpp.
|
inline |
Constructor.
Definition at line 99 of file MueLu_Maxwell1_decl.hpp.
|
inline |
Constructor with Hierarchies.
Definition at line 106 of file MueLu_Maxwell1_decl.hpp.
|
inline |
Constructor with Jacobian
[in] | SM_Matrix | Jacobian |
[in] | D0_Matrix | Discrete Gradient |
[in] | Nullspace | Null space (needed for periodic) |
[in] | Coords | Nodal coordinates |
[in] | List | Parameter list |
[in] | ComputePrec | If true, compute the preconditioner immediately |
Definition at line 121 of file MueLu_Maxwell1_decl.hpp.
|
inline |
Constructor with Jacobian and nodal matrix
[in] | SM_Matrix | Jacobian |
[in] | D0_Matrix | Discrete Gradient |
[in] | Kn_Matrix | Nodal Laplacian |
[in] | Coords | Nodal coordinates |
[in] | List | Parameter list |
[in] | ComputePrec | If true, compute the preconditioner immediately |
Definition at line 142 of file MueLu_Maxwell1_decl.hpp.
|
inline |
Constructor with parameter list
[in] | SM_Matrix | Jacobian |
[in] | List | Parameter list |
[in] | ComputePrec | If true, compute the preconditioner immediately |
Definition at line 161 of file MueLu_Maxwell1_decl.hpp.
|
inlinevirtual |
Destructor.
Definition at line 180 of file MueLu_Maxwell1_decl.hpp.
Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > MueLu::Maxwell1< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getDomainMap | ( | ) | const |
Returns the Xpetra::Map object associated with the domain of this operator.
Definition at line 91 of file MueLu_Maxwell1_def.hpp.
Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > MueLu::Maxwell1< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getRangeMap | ( | ) | const |
Returns the Xpetra::Map object associated with the range of this operator.
Definition at line 97 of file MueLu_Maxwell1_def.hpp.
|
inline |
Returns Jacobian matrix SM.
Definition at line 189 of file MueLu_Maxwell1_decl.hpp.
void MueLu::Maxwell1< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setParameters | ( | Teuchos::ParameterList & | list | ) |
Set parameters.
Definition at line 103 of file MueLu_Maxwell1_def.hpp.
void MueLu::Maxwell1< Scalar, LocalOrdinal, GlobalOrdinal, Node >::compute | ( | bool | reuse = false | ) |
Setup the preconditioner.
Definition at line 200 of file MueLu_Maxwell1_def.hpp.
void MueLu::Maxwell1< Scalar, LocalOrdinal, GlobalOrdinal, Node >::resetMatrix | ( | Teuchos::RCP< Matrix > | SM_Matrix_new, |
bool | ComputePrec = true |
||
) |
Reset system matrix.
Definition at line 493 of file MueLu_Maxwell1_def.hpp.
void MueLu::Maxwell1< Scalar, LocalOrdinal, GlobalOrdinal, Node >::apply | ( | const MultiVector & | X, |
MultiVector & | Y, | ||
Teuchos::ETransp | mode = Teuchos::NO_TRANS , |
||
Scalar | alpha = Teuchos::ScalarTraits<Scalar>::one() , |
||
Scalar | beta = Teuchos::ScalarTraits<Scalar>::zero() |
||
) | const |
Returns in Y the result of a Xpetra::Operator applied to a Xpetra::MultiVector X.
[in] | X | - MultiVector of dimension NumVectors to multiply with matrix. |
[out] | Y | - MultiVector of dimension NumVectors containing result. |
Definition at line 564 of file MueLu_Maxwell1_def.hpp.
bool MueLu::Maxwell1< Scalar, LocalOrdinal, GlobalOrdinal, Node >::hasTransposeApply | ( | ) | const |
Indicates whether this operator supports applying the adjoint operator.
Definition at line 580 of file MueLu_Maxwell1_def.hpp.
void MueLu::Maxwell1< Scalar, LocalOrdinal, GlobalOrdinal, Node >::describe | ( | Teuchos::FancyOStream & | out, |
const Teuchos::EVerbosityLevel | verbLevel = Teuchos::VERB_HIGH |
||
) | const |
Definition at line 670 of file MueLu_Maxwell1_def.hpp.
|
inline |
Compute a residual R = B - (*this) * X.
Definition at line 216 of file MueLu_Maxwell1_decl.hpp.
|
private |
Generates the Kn matrix.
Definition at line 356 of file MueLu_Maxwell1_def.hpp.
|
private |
Initialize with matrices except the Jacobian (don't compute the preconditioner)
[in] | D0_Matrix | Discrete Gradient |
[in] | Kn_Matrix | Kn nodal matrix |
[in] | Nullspace | Null space (needed for periodic) |
[in] | Coords | Nodal coordinates |
[in] | List | Parameter list |
Definition at line 587 of file MueLu_Maxwell1_def.hpp.
|
private |
apply RefMaxwell additive 2x2 style cycle
Definition at line 503 of file MueLu_Maxwell1_def.hpp.
|
private |
apply standard Maxwell1 cycle
Definition at line 559 of file MueLu_Maxwell1_def.hpp.
|
private |
allocate multivectors for solve
Definition at line 400 of file MueLu_Maxwell1_def.hpp.
|
private |
dump out matrix
Definition at line 424 of file MueLu_Maxwell1_def.hpp.
|
private |
dump out multivector
Definition at line 433 of file MueLu_Maxwell1_def.hpp.
|
private |
dump out real-valued multivector
Definition at line 442 of file MueLu_Maxwell1_def.hpp.
|
private |
dump out boolean ArrayView
Definition at line 451 of file MueLu_Maxwell1_def.hpp.
|
private |
get a (synced) timer
Definition at line 475 of file MueLu_Maxwell1_def.hpp.
|
mutableprivate |
ParameterLists.
Definition at line 275 of file MueLu_Maxwell1_decl.hpp.
|
mutableprivate |
Definition at line 275 of file MueLu_Maxwell1_decl.hpp.
|
mutableprivate |
Definition at line 275 of file MueLu_Maxwell1_decl.hpp.
|
private |
Two hierarchies: one for the (1,1)-block, another for the (2,2)-block.
Definition at line 278 of file MueLu_Maxwell1_decl.hpp.
|
private |
Definition at line 278 of file MueLu_Maxwell1_decl.hpp.
|
private |
Various matrices.
Definition at line 281 of file MueLu_Maxwell1_decl.hpp.
|
private |
Definition at line 281 of file MueLu_Maxwell1_decl.hpp.
|
private |
Definition at line 281 of file MueLu_Maxwell1_decl.hpp.
|
private |
Vectors for BCs.
Definition at line 287 of file MueLu_Maxwell1_decl.hpp.
|
private |
Definition at line 287 of file MueLu_Maxwell1_decl.hpp.
|
private |
Definition at line 288 of file MueLu_Maxwell1_decl.hpp.
|
private |
Definition at line 288 of file MueLu_Maxwell1_decl.hpp.
|
private |
Definition at line 288 of file MueLu_Maxwell1_decl.hpp.
|
private |
Nullspace.
Definition at line 290 of file MueLu_Maxwell1_decl.hpp.
|
private |
Coordinates.
Definition at line 292 of file MueLu_Maxwell1_decl.hpp.
|
private |
Some options.
Definition at line 294 of file MueLu_Maxwell1_decl.hpp.
|
private |
Definition at line 294 of file MueLu_Maxwell1_decl.hpp.
|
private |
Definition at line 294 of file MueLu_Maxwell1_decl.hpp.
|
private |
Definition at line 294 of file MueLu_Maxwell1_decl.hpp.
|
private |
Definition at line 294 of file MueLu_Maxwell1_decl.hpp.
|
private |
Definition at line 294 of file MueLu_Maxwell1_decl.hpp.
|
private |
Definition at line 295 of file MueLu_Maxwell1_decl.hpp.
|
private |
Definition at line 299 of file MueLu_Maxwell1_decl.hpp.
|
private |
Temporary memory (cached vectors for RefMaxwell-style)
Definition at line 302 of file MueLu_Maxwell1_decl.hpp.
|
mutableprivate |
Definition at line 303 of file MueLu_Maxwell1_decl.hpp.
|
mutableprivate |
Definition at line 303 of file MueLu_Maxwell1_decl.hpp.
|
mutableprivate |
Definition at line 303 of file MueLu_Maxwell1_decl.hpp.
|
mutableprivate |
Definition at line 303 of file MueLu_Maxwell1_decl.hpp.
|
mutableprivate |
Definition at line 303 of file MueLu_Maxwell1_decl.hpp.