|
MueLu
Version of the Day
|
Preconditioner (wrapped as a Xpetra::Operator) for Maxwell's equations in curl-curl form. More...
#include <MueLu_RefMaxwell_fwd.hpp>
Public Types | |
| typedef Teuchos::ScalarTraits < Scalar >::magnitudeType | magnitudeType |
| typedef Xpetra::MultiVector < magnitudeType, LO, GO, NO > | RealValuedMultiVector |
Public Member Functions | |
| RefMaxwell () | |
| Constructor. More... | |
| RefMaxwell (Teuchos::RCP< Hierarchy > HH, Teuchos::RCP< Hierarchy > H22) | |
| Constructor with Hierarchies. More... | |
| RefMaxwell (const Teuchos::RCP< Matrix > &SM_Matrix, const Teuchos::RCP< Matrix > &D0_Matrix, const Teuchos::RCP< Matrix > &Ms_Matrix, const Teuchos::RCP< Matrix > &M0inv_Matrix, const Teuchos::RCP< Matrix > &M1_Matrix, const Teuchos::RCP< MultiVector > &Nullspace, const Teuchos::RCP< RealValuedMultiVector > &Coords, Teuchos::ParameterList &List, bool ComputePrec=true) | |
| RefMaxwell (const Teuchos::RCP< Matrix > &SM_Matrix, const Teuchos::RCP< Matrix > &D0_Matrix, const Teuchos::RCP< Matrix > &M0inv_Matrix, const Teuchos::RCP< Matrix > &M1_Matrix, const Teuchos::RCP< MultiVector > &Nullspace, const Teuchos::RCP< RealValuedMultiVector > &Coords, Teuchos::ParameterList &List, bool ComputePrec=true) | |
| RefMaxwell (const Teuchos::RCP< Matrix > &D0_Matrix, const Teuchos::RCP< Matrix > &M0inv_Matrix, const Teuchos::RCP< Matrix > &M1_Matrix, const Teuchos::RCP< MultiVector > &Nullspace, const Teuchos::RCP< RealValuedMultiVector > &Coords, Teuchos::ParameterList &List) | |
| RefMaxwell (const Teuchos::RCP< Matrix > &SM_Matrix, const Teuchos::RCP< Matrix > &D0_Matrix, const Teuchos::RCP< Matrix > &M1_Matrix, const Teuchos::RCP< MultiVector > &Nullspace, const Teuchos::RCP< RealValuedMultiVector > &Coords, Teuchos::ParameterList &List, bool ComputePrec) | |
| RefMaxwell (const Teuchos::RCP< Matrix > &D0_Matrix, const Teuchos::RCP< Matrix > &M1_Matrix, const Teuchos::RCP< MultiVector > &Nullspace, const Teuchos::RCP< RealValuedMultiVector > &Coords, Teuchos::ParameterList &List) | |
| RefMaxwell (const Teuchos::RCP< Matrix > &SM_Matrix, Teuchos::ParameterList &List, bool ComputePrec=true) | |
| virtual | ~RefMaxwell () |
| 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 | buildProlongator () |
| Setup the prolongator for the (1,1)-block. More... | |
| void | formCoarseMatrix () |
| Compute P11^{T}*A*P11 efficiently. 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 |
Public Member Functions inherited from MueLu::VerboseObject | |
| 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... | |
Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject > | |
| VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null) | |
| virtual const VerboseObject & | setVerbLevel (const EVerbosityLevel verbLevel) const |
| virtual const VerboseObject & | setOverridingVerbLevel (const EVerbosityLevel verbLevel) const |
| virtual EVerbosityLevel | getVerbLevel () const |
| TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< const ParameterList > | getValidVerboseObjectSublist () |
| TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void | setupVerboseObjectSublist (ParameterList *paramList) |
| TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void | readVerboseObjectSublist (ParameterList *paramList, RCP< FancyOStream > *oStream, EVerbosityLevel *verbLevel) |
| void | readVerboseObjectSublist (ParameterList *paramList, VerboseObject< ObjectType > *verboseObject) |
Public Member Functions inherited from Teuchos::VerboseObjectBase | |
| virtual | ~VerboseObjectBase () |
| VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null) | |
| virtual const VerboseObjectBase & | setOStream (const RCP< FancyOStream > &oStream) const |
| virtual const VerboseObjectBase & | setOverridingOStream (const RCP< FancyOStream > &oStream) const |
| virtual VerboseObjectBase & | setLinePrefix (const std::string &linePrefix) |
| virtual RCP< FancyOStream > | getOStream () const |
| virtual RCP< FancyOStream > | getOverridingOStream () const |
| virtual std::string | getLinePrefix () const |
| virtual OSTab | getOSTab (const int tabs=1, const std::string &linePrefix="") const |
Public Member Functions inherited from Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > | |
| virtual void | removeEmptyProcessesInPlace (const RCP< const Map > &) |
Public Member Functions inherited from Teuchos::Describable | |
| virtual std::string | description () const |
| void | describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const |
| virtual | ~Describable () |
| LabeledObject () | |
| virtual | ~LabeledObject () |
| virtual void | setObjectLabel (const std::string &objectLabel) |
| virtual std::string | getObjectLabel () const |
| DescribableStreamManipulatorState | describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default) |
| std::ostream & | operator<< (std::ostream &os, const DescribableStreamManipulatorState &d) |
Private Member Functions | |
| void | initialize (const Teuchos::RCP< Matrix > &D0_Matrix, const Teuchos::RCP< Matrix > &Ms_Matrix, const Teuchos::RCP< Matrix > &M0inv_Matrix, const Teuchos::RCP< Matrix > &M1_Matrix, const Teuchos::RCP< MultiVector > &Nullspace, const Teuchos::RCP< RealValuedMultiVector > &Coords, Teuchos::ParameterList &List) |
| void | applyInverseAdditive (const MultiVector &RHS, MultiVector &X) const |
| apply additive algorithm for 2x2 solve More... | |
| void | applyInverse121 (const MultiVector &RHS, MultiVector &X) const |
| apply 1-2-1 algorithm for 2x2 solve More... | |
| void | applyInverse212 (const MultiVector &RHS, MultiVector &X) const |
| apply 2-1-2 algorithm for 2x2 solve More... | |
| void | solveH (const MultiVector &RHS, MultiVector &X) const |
| apply solve to 1-1 block only More... | |
| void | solve22 (const MultiVector &RHS, MultiVector &X) const |
| apply solve to 2-2 block only More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from MueLu::VerboseObject | |
| static void | SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream) |
| 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... | |
Static Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject > | |
| static void | setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel) |
| static EVerbosityLevel | getDefaultVerbLevel () |
Static Public Member Functions inherited from Teuchos::VerboseObjectBase | |
| static void | setDefaultOStream (const RCP< FancyOStream > &defaultOStream) |
| static RCP< FancyOStream > | getDefaultOStream () |
Static Public Attributes inherited from Teuchos::Describable | |
| static const EVerbosityLevel | verbLevel_default |
Protected Member Functions inherited from Teuchos::VerboseObject< VerboseObject > | |
| void | initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null) |
Protected Member Functions inherited from Teuchos::VerboseObjectBase | |
| void | initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null) |
| virtual void | informUpdatedVerbosityState () const |
Preconditioner (wrapped as a Xpetra::Operator) for Maxwell's equations in curl-curl form.
This uses a 2x2 block reformulation.
Reference: P. Bochev, J. Hu, C. Siefert, and R. Tuminaro. "An algebraic multigrid approach based on a compatible gauge reformulation of Maxwell's equations." SIAM Journal on Scientific Computing, 31(1), 557-583.
Parameter list options:
refmaxwell: mode - a string specifying the order of solve of the block system. Allowed values are: "additive" (default), "121", "212", "1", "2"refmaxwell: disable addon - bool specifing whether the addon should be built for stabilization. Default: "true"refmaxwell: use as preconditioner - bool specifing whether RefMaxwell is used as a preconditioner or as a solver.refmaxwell: dump matrices - bool specifing whether the matrices should be dumped. Default: "false"refmaxwell: prolongator compute algorithm - a string specifying the algorithm to build the prolongator. Allowed values are: "mat-mat" and "gustavson"refmaxwell: 11list and refmaxwell: 22list - parameter list for the multigrid hierarchies on 11 and 22 blocksrefmaxwell: subsolves on subcommunicators - bool redistribute the two subsolves to disjoint sub-communicators (so that the additive solve can occur in parallel) Default: "false" Definition at line 54 of file MueLu_RefMaxwell_fwd.hpp.
| typedef Teuchos::ScalarTraits<Scalar>::magnitudeType MueLu::RefMaxwell< Scalar, LocalOrdinal, GlobalOrdinal, Node >::magnitudeType |
Definition at line 132 of file MueLu_RefMaxwell_decl.hpp.
| typedef Xpetra::MultiVector<magnitudeType,LO,GO,NO> MueLu::RefMaxwell< Scalar, LocalOrdinal, GlobalOrdinal, Node >::RealValuedMultiVector |
Definition at line 133 of file MueLu_RefMaxwell_decl.hpp.
|
inline |
Constructor.
Definition at line 136 of file MueLu_RefMaxwell_decl.hpp.
|
inline |
Constructor with Hierarchies.
Definition at line 145 of file MueLu_RefMaxwell_decl.hpp.
|
inline |
Constructor with Jacobian (with add on)
| [in] | SM_Matrix | Jacobian |
| [in] | D0_Matrix | Discrete Gradient |
| [in] | Ms_Matrix | Edge mass matrix for the nodal aggregates |
| [in] | M0inv_Matrix | Inverse of lumped nodal mass matrix (add on only) |
| [in] | M1_Matrix | Edge mass matrix for the add on |
| [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 165 of file MueLu_RefMaxwell_decl.hpp.
|
inline |
Constructor with Jacobian (with add on)
| [in] | SM_Matrix | Jacobian |
| [in] | D0_Matrix | Discrete Gradient |
| [in] | M0inv_Matrix | Inverse of lumped nodal mass matrix (add on only) |
| [in] | M1_Matrix | Edge mass matrix for the |
| [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 190 of file MueLu_RefMaxwell_decl.hpp.
|
inline |
Constructor without Jacobian (with add on)
| [in] | D0_Matrix | Discrete Gradient |
| [in] | M0inv_Matrix | Inverse of lumped nodal mass matrix (add on only) |
| [in] | M1_Matrix | Edge mass matrix for the |
| [in] | Nullspace | Null space (needed for periodic) |
| [in] | Coords | Nodal coordinates |
| [in] | List | Parameter list |
Definition at line 212 of file MueLu_RefMaxwell_decl.hpp.
|
inline |
Constructor with Jacobian (no add on)
| [in] | SM_Matrix | Jacobian |
| [in] | D0_Matrix | Discrete Gradient |
| [in] | M1_Matrix | Edge mass matrix for the |
| [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 232 of file MueLu_RefMaxwell_decl.hpp.
|
inline |
Constructor without Jacobian (no add on)
| [in] | D0_Matrix | Discrete Gradient |
| [in] | M1_Matrix | Edge mass matrix for the |
| [in] | Nullspace | Null space (needed for periodic) |
| [in] | Coords | Nodal coordinates |
| [in] | List | Parameter list |
Definition at line 252 of file MueLu_RefMaxwell_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 267 of file MueLu_RefMaxwell_decl.hpp.
|
inlinevirtual |
Destructor.
Definition at line 290 of file MueLu_RefMaxwell_decl.hpp.
|
virtual |
Returns the Xpetra::Map object associated with the domain of this operator.
Implements Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 107 of file MueLu_RefMaxwell_def.hpp.
|
virtual |
Returns the Xpetra::Map object associated with the range of this operator.
Implements Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 113 of file MueLu_RefMaxwell_def.hpp.
|
inline |
Returns Jacobian matrix SM.
Definition at line 299 of file MueLu_RefMaxwell_decl.hpp.
| void MueLu::RefMaxwell< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setParameters | ( | Teuchos::ParameterList & | list | ) |
Set parameters.
Definition at line 119 of file MueLu_RefMaxwell_def.hpp.
| void MueLu::RefMaxwell< Scalar, LocalOrdinal, GlobalOrdinal, Node >::compute | ( | bool | reuse = false | ) |
Setup the preconditioner.
Definition at line 172 of file MueLu_RefMaxwell_def.hpp.
| void MueLu::RefMaxwell< Scalar, LocalOrdinal, GlobalOrdinal, Node >::buildProlongator | ( | ) |
Setup the prolongator for the (1,1)-block.
Definition at line 1082 of file MueLu_RefMaxwell_def.hpp.
| void MueLu::RefMaxwell< Scalar, LocalOrdinal, GlobalOrdinal, Node >::formCoarseMatrix | ( | ) |
Compute P11^{T}*A*P11 efficiently.
Definition at line 1591 of file MueLu_RefMaxwell_def.hpp.
| void MueLu::RefMaxwell< Scalar, LocalOrdinal, GlobalOrdinal, Node >::resetMatrix | ( | Teuchos::RCP< Matrix > | SM_Matrix_new, |
| bool | ComputePrec = true |
||
| ) |
Reset system matrix.
Definition at line 1728 of file MueLu_RefMaxwell_def.hpp.
|
virtual |
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. |
Implements Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 1952 of file MueLu_RefMaxwell_def.hpp.
| bool MueLu::RefMaxwell< Scalar, LocalOrdinal, GlobalOrdinal, Node >::hasTransposeApply | ( | ) | const |
Indicates whether this operator supports applying the adjoint operator.
Definition at line 2030 of file MueLu_RefMaxwell_def.hpp.
|
virtual |
Reimplemented from Teuchos::Describable.
Definition at line 2070 of file MueLu_RefMaxwell_def.hpp.
|
private |
Initialize with matrices except the Jacobian (don't compute the preconditioner)
| [in] | D0_Matrix | Discrete Gradient |
| [in] | Ms_Matrix | Edge mass matrix for nodal aggregates |
| [in] | M0inv_Matrix | Inverse of lumped nodal mass matrix (add on only) |
| [in] | M1_Matrix | Edge mass matrix for add on |
| [in] | Nullspace | Null space (needed for periodic) |
| [in] | Coords | Nodal coordinates |
| [in] | List | Parameter list |
Definition at line 2037 of file MueLu_RefMaxwell_def.hpp.
|
private |
apply additive algorithm for 2x2 solve
Definition at line 1737 of file MueLu_RefMaxwell_def.hpp.
|
private |
apply 1-2-1 algorithm for 2x2 solve
Definition at line 1829 of file MueLu_RefMaxwell_def.hpp.
|
private |
apply 2-1-2 algorithm for 2x2 solve
Definition at line 1842 of file MueLu_RefMaxwell_def.hpp.
|
private |
apply solve to 1-1 block only
Definition at line 1854 of file MueLu_RefMaxwell_def.hpp.
|
private |
apply solve to 2-2 block only
Definition at line 1903 of file MueLu_RefMaxwell_def.hpp.
|
private |
Two hierarchies: one for the coarse (1,1)-block, another for the (2,2)-block.
Definition at line 378 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 378 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 379 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 379 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 383 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Various matrices.
Definition at line 385 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 385 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 385 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 385 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 385 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 385 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 386 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 386 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 386 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 386 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 386 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 386 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Vectors for BCs.
Definition at line 392 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 392 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 393 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 394 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Nullspace.
Definition at line 396 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Coordinates.
Definition at line 398 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 398 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Importer to coarse (1,1) hierarchy.
Definition at line 400 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 400 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Parameter lists.
Definition at line 402 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 402 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 402 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 402 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 403 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 403 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 404 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 404 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Some options.
Definition at line 406 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 406 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 406 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 406 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 406 of file MueLu_RefMaxwell_decl.hpp.
|
private |
Definition at line 407 of file MueLu_RefMaxwell_decl.hpp.
|
mutableprivate |
Temporary memory.
Definition at line 409 of file MueLu_RefMaxwell_decl.hpp.
|
mutableprivate |
Definition at line 409 of file MueLu_RefMaxwell_decl.hpp.
|
mutableprivate |
Definition at line 409 of file MueLu_RefMaxwell_decl.hpp.
|
mutableprivate |
Definition at line 409 of file MueLu_RefMaxwell_decl.hpp.
|
mutableprivate |
Definition at line 409 of file MueLu_RefMaxwell_decl.hpp.
|
mutableprivate |
Definition at line 409 of file MueLu_RefMaxwell_decl.hpp.
|
mutableprivate |
Definition at line 409 of file MueLu_RefMaxwell_decl.hpp.
|
mutableprivate |
Definition at line 409 of file MueLu_RefMaxwell_decl.hpp.
|
mutableprivate |
Definition at line 409 of file MueLu_RefMaxwell_decl.hpp.