MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Private Types | Private Member Functions | Private Attributes | List of all members
MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

#include <MueLu_BrickAggregationFactory_decl.hpp>

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

Classes

class  compare
 

Private Types

typedef Teuchos::ScalarTraits
< Scalar > 		STS
 
typedef std::map< Scalar,
GlobalOrdinal, compare > 		container
 

Private Member Functions

void Setup (const RCP< const Teuchos::Comm< int > > &comm, const RCP< Xpetra::MultiVector< typename Teuchos::ScalarTraits< Scalar >::magnitudeType, LO, GO, NO > > &coords, const RCP< const Map > &map) const
 
RCP< container > Construct1DMap (const RCP< const Teuchos::Comm< int > > &comm, const ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &x) const
 
bool isRoot (LocalOrdinal LID) const
 
GlobalOrdinal getRoot (LocalOrdinal LID) const
 
GlobalOrdinal getAggGID (LocalOrdinal LID) const
 

Private Attributes

int nDim_
 
RCP< container > xMap_
 
RCP< container > yMap_
 
RCP< container > zMap_
 
ArrayRCP< const typename
Teuchos::ScalarTraits< Scalar >
::magnitudeType > 		x_
 
ArrayRCP< const typename
Teuchos::ScalarTraits< Scalar >
::magnitudeType > 		y_
 
ArrayRCP< const typename
Teuchos::ScalarTraits< Scalar >
::magnitudeType > 		z_
 
int nx_
 
int ny_
 
int nz_
 
int bx_
 
int by_
 
int bz_
 
std::map< GlobalOrdinal,
GlobalOrdinal > 		revMap_
 

Constructors/Destructors.

 BrickAggregationFactory ()
 Constructor. More...
 
virtual ~BrickAggregationFactory ()
 Destructor. More...
 
RCP< const ParameterList > GetValidParameterList () const
 Return a const parameter list of valid parameters that setParameterList() will accept. More...
 
void DeclareInput (Level &currentLevel) const
 Input. More...
 

Build methods.

void Build (Level &currentLevel) const
 Build aggregates. More...
 

Additional Inherited Members

- Public Member Functions inherited from MueLu::SingleLevelFactoryBase
 SingleLevelFactoryBase ()
 Constructor. More...
 
virtual ~SingleLevelFactoryBase ()
 Destructor. More...
 
virtual void CallBuild (Level &requestedLevel) const
 
virtual void CallDeclareInput (Level &requestedLevel) const
 
- Public Member Functions inherited from MueLu::Factory
void EnableMultipleCallCheck () const
 Constructor. More...
 
void DisableMultipleCallCheck () const
 
void ResetDebugData () 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 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 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 Teuchos::Describable
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
 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)
 
- Public Member Functions inherited from MueLu::FactoryAcceptor
virtual ~FactoryAcceptor ()
 
virtual void SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)=0
 Configuration. More...
 
virtual const RCP< const
FactoryBase > 		GetFactory (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. 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
 
- Static Public Member Functions inherited from MueLu::Factory
static void EnableMultipleCheckGlobally ()
 
static void DisableMultipleCheckGlobally ()
 
- 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
 

Detailed Description

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Definition at line 82 of file MueLu_BrickAggregationFactory_decl.hpp.

Member Typedef Documentation

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
typedef Teuchos::ScalarTraits<Scalar> MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::STS
private

Definition at line 86 of file MueLu_BrickAggregationFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
typedef std::map<Scalar,GlobalOrdinal,compare> MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::container
private

Definition at line 102 of file MueLu_BrickAggregationFactory_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BrickAggregationFactory ( )
inline

Constructor.

Definition at line 109 of file MueLu_BrickAggregationFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~BrickAggregationFactory ( )
inlinevirtual

Destructor.

Definition at line 112 of file MueLu_BrickAggregationFactory_decl.hpp.

Member Function Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const ParameterList > BrickAggregationFactory::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.

Implements MueLu::ParameterListAcceptor.

Definition at line 73 of file MueLu_BrickAggregationFactory_def.hpp.

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

Input.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 89 of file MueLu_BrickAggregationFactory_def.hpp.

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

Build aggregates.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 139 of file MueLu_BrickAggregationFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void BrickAggregationFactory::Setup ( const RCP< const Teuchos::Comm< int > > &  comm,
const RCP< Xpetra::MultiVector< typename Teuchos::ScalarTraits< Scalar >::magnitudeType, LO, GO, NO > > &  coords,
const RCP< const Map > &  map 
) const
private

Definition at line 269 of file MueLu_BrickAggregationFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< typename BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::container > BrickAggregationFactory::Construct1DMap ( const RCP< const Teuchos::Comm< int > > &  comm,
const ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &  x 
) const
private

Definition at line 304 of file MueLu_BrickAggregationFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
bool BrickAggregationFactory::isRoot ( LocalOrdinal  LID) const
private

Definition at line 353 of file MueLu_BrickAggregationFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
GlobalOrdinal BrickAggregationFactory::getRoot ( LocalOrdinal  LID) const
private

Definition at line 364 of file MueLu_BrickAggregationFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
GlobalOrdinal BrickAggregationFactory::getAggGID ( LocalOrdinal  LID) const
private

Definition at line 380 of file MueLu_BrickAggregationFactory_def.hpp.

Member Data Documentation

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
int MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::nDim_
mutableprivate

Definition at line 144 of file MueLu_BrickAggregationFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
RCP<container> MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::xMap_
mutableprivate

Definition at line 146 of file MueLu_BrickAggregationFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
RCP<container> MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::yMap_
mutableprivate

Definition at line 146 of file MueLu_BrickAggregationFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
RCP<container> MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::zMap_
mutableprivate

Definition at line 146 of file MueLu_BrickAggregationFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
ArrayRCP<const typename Teuchos::ScalarTraits<Scalar>::magnitudeType> MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::x_
mutableprivate

Definition at line 148 of file MueLu_BrickAggregationFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
ArrayRCP<const typename Teuchos::ScalarTraits<Scalar>::magnitudeType> MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::y_
mutableprivate

Definition at line 148 of file MueLu_BrickAggregationFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
ArrayRCP<const typename Teuchos::ScalarTraits<Scalar>::magnitudeType> MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::z_
mutableprivate

Definition at line 148 of file MueLu_BrickAggregationFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
int MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::nx_
mutableprivate

Definition at line 150 of file MueLu_BrickAggregationFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
int MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ny_
mutableprivate

Definition at line 150 of file MueLu_BrickAggregationFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
int MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::nz_
mutableprivate

Definition at line 150 of file MueLu_BrickAggregationFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
int MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::bx_
mutableprivate

Definition at line 152 of file MueLu_BrickAggregationFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
int MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::by_
mutableprivate

Definition at line 152 of file MueLu_BrickAggregationFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
int MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::bz_
mutableprivate

Definition at line 152 of file MueLu_BrickAggregationFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
std::map<GlobalOrdinal,GlobalOrdinal> MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::revMap_
mutableprivate

Definition at line 154 of file MueLu_BrickAggregationFactory_decl.hpp.

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