MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu::SchurComplementFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Factory for building the Schur Complement for a 2x2 block matrix. More...

#include <MueLu_SchurComplementFactory_decl.hpp>

Inheritance diagram for MueLu::SchurComplementFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
MueLu::SingleLevelFactoryBase MueLu::Factory MueLu::FactoryBase MueLu::FactoryAcceptor MueLu::ParameterListAcceptorImpl MueLu::BaseClass MueLu::ParameterListAcceptor MueLu::VerboseObject MueLu::Describable

Constructors/Destructors.

 SchurComplementFactory ()=default
 Constructor.
 
void DeclareInput (Level &currentLevel) const
 Input.
 
RCP< const ParameterList > GetValidParameterList () const
 Return a const parameter list of valid parameters that setParameterList() will accept.
 

Build methods.

void Build (Level &currentLevel) const
 Build an object with this factory.
 
RCP< Matrix > ComputeSchurComplement (RCP< BlockedCrsMatrix > &bA, RCP< Matrix > &Ainv) const
 Schur complement calculation method.
 

Additional Inherited Members

- Public Member Functions inherited from MueLu::SingleLevelFactoryBase
 SingleLevelFactoryBase ()
 Constructor.
 
virtual ~SingleLevelFactoryBase ()
 Destructor.
 
virtual void CallBuild (Level &requestedLevel) const
 
virtual void CallDeclareInput (Level &requestedLevel) const
 
- Public Member Functions inherited from MueLu::Factory
 Factory ()
 Constructor.
 
virtual ~Factory ()
 Destructor.
 
virtual void SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)
 Configuration.
 
const RCP< const FactoryBaseGetFactory (const std::string &varName) const
 Default implementation of FactoryAcceptor::GetFactory()
 
RCP< ParameterList > RemoveFactoriesFromList (const ParameterList &list) const
 
virtual RCP< const ParameterList > GetValidParameterList () const
 Return a const parameter list of valid parameters that setParameterList() will accept.
 
void EnableMultipleCallCheck () const
 
void DisableMultipleCallCheck () const
 
void ResetDebugData () const
 
- Public Member Functions inherited from MueLu::FactoryBase
 FactoryBase ()
 Constructor.
 
virtual ~FactoryBase ()
 Destructor.
 
int GetID () const
 return unique factory id
 
- Public Member Functions inherited from MueLu::BaseClass
virtual ~BaseClass ()
 Destructor.
 
- Public Member Functions inherited from MueLu::VerboseObject
 VerboseObject ()
 
virtual ~VerboseObject ()
 Destructor.
 
VerbLevel GetVerbLevel () const
 Get the verbosity level.
 
void SetVerbLevel (const VerbLevel verbLevel)
 Set the verbosity level of this object.
 
int GetProcRankVerbose () const
 Get proc rank used for printing. Do not use this information for any other purpose.
 
int SetProcRankVerbose (int procRank) const
 Set proc rank used for printing.
 
bool IsPrint (MsgType type, int thisProcRankOnly=-1) const
 Find out whether we need to print out information for a specific message type.
 
Teuchos::FancyOStream & GetOStream (MsgType type, int thisProcRankOnly=0) const
 Get an output stream for outputting the input message type.
 
Teuchos::FancyOStream & GetBlackHole () const
 
- Public Member Functions inherited from MueLu::Describable
virtual ~Describable ()
 Destructor.
 
virtual void describe (Teuchos::FancyOStream &out_arg, const VerbLevel verbLevel=Default) const
 
virtual std::string description () const
 Return a simple one-line description of this object.
 
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
 Print the object with some verbosity level to an FancyOStream object.
 
virtual std::string ShortClassName () const
 Return the class name of the object, without template parameters and without namespace.
 
- Public Member Functions inherited from MueLu::FactoryAcceptor
virtual ~FactoryAcceptor ()
 
virtual void SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)=0
 Configuration.
 
virtual const RCP< const FactoryBaseGetFactory (const std::string &varName) const =0
 
- Public Member Functions inherited from MueLu::ParameterListAcceptorImpl
 ParameterListAcceptorImpl ()
 
virtual ~ParameterListAcceptorImpl ()=default
 
virtual void SetParameterList (const Teuchos::ParameterList &paramList)
 Set parameters from a parameter list and return with default values.
 
virtual const Teuchos::ParameterList & GetParameterList () const
 
void SetParameter (const std::string &name, const ParameterEntry &entry)
 Set a parameter directly as a ParameterEntry.
 
const ParameterEntry & GetParameter (const std::string &name) const
 Retrieves a const entry with the name name.
 
virtual void GetDocumentation (std::ostream &os) const
 
- Public Member Functions inherited from MueLu::ParameterListAcceptor
 ParameterListAcceptor ()
 
virtual ~ParameterListAcceptor ()=default
 
- Static Public Member Functions inherited from MueLu::Factory
static void EnableTimerSync ()
 
static void DisableTimerSync ()
 
static void EnableMultipleCheckGlobally ()
 
static void DisableMultipleCheckGlobally ()
 
- Static Public Member Functions inherited from MueLu::VerboseObject
static void SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
 Set the default (global) verbosity level.
 
static VerbLevel GetDefaultVerbLevel ()
 Get the default (global) verbosity level.
 
static void SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream)
 
static void SetMueLuOFileStream (const std::string &filename)
 
static Teuchos::RCP< Teuchos::FancyOStream > GetMueLuOStream ()
 
- Protected Member Functions inherited from MueLu::Factory
void Input (Level &level, const std::string &varName) const
 
void Input (Level &level, const std::string &varName, const std::string &varParamName) const
 
template<class T >
Get (Level &level, const std::string &varName) const
 
template<class T >
Get (Level &level, const std::string &varName, const std::string &varParamName) const
 
template<class T >
void Set (Level &level, const std::string &varName, const T &data) const
 
bool IsAvailable (Level &level, const std::string &varName) const
 
- Static Protected Attributes inherited from MueLu::Factory
static bool timerSync_ = false
 

Detailed Description

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
class MueLu::SchurComplementFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Factory for building the Schur Complement for a 2x2 block matrix.

Context, assumptions, and use cases

This factory is intended to be used for building the schur complement for respective smoothers. The calculation is for now restricted to 2x2 block matrices, where the schur complement is calculated on block A_11.

For a blocked matrix \A = [A_00 A_01; A_10 A_11] it computes the Schur complement S = A_11 - 1/\omega A_10 Ainv A_01, where \omega is some scaling factor and \Ainv an approximation of A_00^{-1} (from InverseApproximationFactory).

Input/output of this factory

User parameters of InterfaceAggregationFactory

Parameter type default master.xml validated requested description
A Factory null * * Generating factory of the matrix A
Ainv Factory null * * Generating factory of the approximate inverse of A (produced by the InverseApproximationFactory)
omega double 1.0 * * Scaling factor

The * in the master.xml column denotes that the parameter is defined in the master.xml file. The * in the validated column means that the parameter is declared in the list of valid input parameters (see GetValidParameters() ). The * in the requested column states that the data is requested as input with all dependencies (see DeclareInput() ).

Variables provided by this factory

After SchurComplementFactory::Build the following data is available (if requested)

Parameter generated by description
A SchurComplementFactory The schur complement of the given block matrix.

Definition at line 115 of file MueLu_SchurComplementFactory_decl.hpp.

Constructor & Destructor Documentation

◆ SchurComplementFactory()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
MueLu::SchurComplementFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SchurComplementFactory ( )
default

Constructor.

Member Function Documentation

◆ DeclareInput()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::SchurComplementFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level currentLevel) const
virtual

Input.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 83 of file MueLu_SchurComplementFactory_def.hpp.

◆ GetValidParameterList()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const ParameterList > MueLu::SchurComplementFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetValidParameterList ( ) const
virtual

Return a const parameter list of valid parameters that setParameterList() will accept.

Also define the default values of parameters according to the input parameter list.

Reimplemented from MueLu::Factory.

Definition at line 69 of file MueLu_SchurComplementFactory_def.hpp.

◆ Build()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::SchurComplementFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Build ( Level currentLevel) const
virtual

Build an object with this factory.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 92 of file MueLu_SchurComplementFactory_def.hpp.

◆ ComputeSchurComplement()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > MueLu::SchurComplementFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ComputeSchurComplement ( RCP< BlockedCrsMatrix > &  bA,
RCP< Matrix > &  Ainv 
) const
private

Schur complement calculation method.

Definition at line 116 of file MueLu_SchurComplementFactory_def.hpp.


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