MueLu  Version of the Day
MueLu::GeometricInterpolationPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

#include <MueLu_GeometricInterpolationPFactory_decl.hpp>

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

Public Types

using real_type = typename Teuchos::ScalarTraits< SC >::coordinateType
 
using realvaluedmultivector_type = Xpetra::MultiVector< real_type, LO, GO, Node >
 

Public Member Functions

RCP< const ParameterList > GetValidParameterList () const
 Return a const parameter list of valid parameters that setParameterList() will accept. More...
 
- Public Member Functions inherited from MueLu::PFactory
 PFactory ()
 Constructor. More...
 
virtual ~PFactory ()
 Destructor. More...
 
void setRestrictionMode (bool bRestrictionMode=false)
 
bool isRestrictionModeSet ()
 returns restrictionMode flag More...
 
- Public Member Functions inherited from MueLu::TwoLevelFactoryBase
 TwoLevelFactoryBase ()
 Constructor. More...
 
virtual ~TwoLevelFactoryBase ()
 Destructor. More...
 
virtual void CallDeclareInput (Level &requestedLevel) const
 
virtual void CallBuild (Level &requestedLevel) const
 
- Public Member Functions inherited from MueLu::Factory
void EnableMultipleCallCheck () const
 
void DisableMultipleCallCheck () const
 
void ResetDebugData () const
 
 Factory ()
 Constructor. More...
 
virtual ~Factory ()
 Destructor. More...
 
virtual void SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)
 Configuration. More...
 
const RCP< const FactoryBaseGetFactory (const std::string &varName) const
 Default implementation of FactoryAcceptor::GetFactory() More...
 
RCP< ParameterList > RemoveFactoriesFromList (const ParameterList &list) const
 
- Public Member Functions inherited from MueLu::FactoryBase
 FactoryBase ()
 Constructor. More...
 
virtual ~FactoryBase ()
 Destructor. More...
 
int GetID () const
 return unique factory id More...
 
- Public Member Functions inherited from MueLu::BaseClass
virtual ~BaseClass ()
 Destructor. More...
 
- 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 MueLu::Describable
virtual ~Describable ()
 Destructor. More...
 
virtual std::string ShortClassName () const
 Return the class name of the object, without template parameters and without namespace. More...
 
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. More...
 
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. More...
 
- Public Member Functions inherited from MueLu::FactoryAcceptor
virtual ~FactoryAcceptor ()
 
- 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. More...
 
virtual const Teuchos::ParameterList & GetParameterList () const
 
void SetParameter (const std::string &name, const ParameterEntry &entry)
 Set a parameter directly as a ParameterEntry. More...
 
const ParameterEntry & GetParameter (const std::string &name) const
 Retrieves a const entry with the name name. More...
 
virtual void GetDocumentation (std::ostream &os) const
 
- Public Member Functions inherited from MueLu::ParameterListAcceptor
 ParameterListAcceptor ()
 
virtual ~ParameterListAcceptor ()=default
 

Private Member Functions

void BuildConstantP (RCP< Matrix > &P, RCP< const CrsGraph > &prolongatorGraph, RCP< Matrix > &A) const
 
void BuildLinearP (Level &coarseLevel, RCP< Matrix > &A, RCP< const CrsGraph > &prolongatorGraph, RCP< realvaluedmultivector_type > &fineCoordinates, RCP< realvaluedmultivector_type > &ghostCoordinates, const int numDimensions, const bool keepD2, RCP< Matrix > &P) const
 
void ComputeLinearInterpolationStencil (const int numDimensions, const int numInterpolationPoints, const Array< Array< real_type > > coord, Array< real_type > &stencil) const
 
void GetInterpolationFunctions (const LO numDimensions, const Teuchos::SerialDenseVector< LO, real_type > parametricCoordinates, real_type functions[4][8]) const
 

Constructors/Destructors.

 GeometricInterpolationPFactory ()
 Constructor. More...
 
virtual ~GeometricInterpolationPFactory ()
 Destructor. More...
 
void DeclareInput (Level &fineLevel, Level &coarseLevel) const
 Input. More...
 

Build methods.

void Build (Level &fineLevel, Level &coarseLevel) const
 Build an object with this factory. More...
 
void BuildP (Level &fineLevel, Level &coarseLevel) const
 Abstract Build method. More...
 

Additional Inherited Members

- 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 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...
 
- 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
 
- Protected Attributes inherited from MueLu::PFactory
bool restrictionMode_
 
- Static Protected Attributes inherited from MueLu::Factory
static bool timerSync_ = false
 

Detailed Description

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
class MueLu::GeometricInterpolationPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Definition at line 63 of file MueLu_GeometricInterpolationPFactory_decl.hpp.

Member Typedef Documentation

◆ real_type

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
using MueLu::GeometricInterpolationPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::real_type = typename Teuchos::ScalarTraits<SC>::coordinateType

◆ realvaluedmultivector_type

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
using MueLu::GeometricInterpolationPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::realvaluedmultivector_type = Xpetra::MultiVector<real_type,LO,GO,Node>

Constructor & Destructor Documentation

◆ GeometricInterpolationPFactory()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::GeometricInterpolationPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GeometricInterpolationPFactory ( )
inline

Constructor.

Definition at line 77 of file MueLu_GeometricInterpolationPFactory_decl.hpp.

◆ ~GeometricInterpolationPFactory()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
virtual MueLu::GeometricInterpolationPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~GeometricInterpolationPFactory ( )
inlinevirtual

Destructor.

Definition at line 80 of file MueLu_GeometricInterpolationPFactory_decl.hpp.

Member Function Documentation

◆ GetValidParameterList()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const ParameterList > MueLu::GeometricInterpolationPFactory< 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 62 of file MueLu_GeometricInterpolationPFactory_def.hpp.

◆ DeclareInput()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::GeometricInterpolationPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level fineLevel,
Level coarseLevel 
) const
virtual

Input.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 98 of file MueLu_GeometricInterpolationPFactory_def.hpp.

◆ Build()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::GeometricInterpolationPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Build ( Level fineLevel,
Level coarseLevel 
) const
virtual

Build an object with this factory.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 119 of file MueLu_GeometricInterpolationPFactory_def.hpp.

◆ BuildP()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::GeometricInterpolationPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildP ( Level fineLevel,
Level coarseLevel 
) const
virtual

Abstract Build method.

Implements MueLu::PFactory.

Definition at line 125 of file MueLu_GeometricInterpolationPFactory_def.hpp.

◆ BuildConstantP()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::GeometricInterpolationPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildConstantP ( RCP< Matrix > &  P,
RCP< const CrsGraph > &  prolongatorGraph,
RCP< Matrix > &  A 
) const
private

◆ BuildLinearP()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::GeometricInterpolationPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildLinearP ( Level coarseLevel,
RCP< Matrix > &  A,
RCP< const CrsGraph > &  prolongatorGraph,
RCP< realvaluedmultivector_type > &  fineCoordinates,
RCP< realvaluedmultivector_type > &  ghostCoordinates,
const int  numDimensions,
const bool  keepD2,
RCP< Matrix > &  P 
) const
private

◆ ComputeLinearInterpolationStencil()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::GeometricInterpolationPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ComputeLinearInterpolationStencil ( const int  numDimensions,
const int  numInterpolationPoints,
const Array< Array< real_type > >  coord,
Array< real_type > &  stencil 
) const
private

◆ GetInterpolationFunctions()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::GeometricInterpolationPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetInterpolationFunctions ( const LO  numDimensions,
const Teuchos::SerialDenseVector< LO, real_type parametricCoordinates,
real_type  functions[4][8] 
) const
private

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