MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu::VariableDofLaplacianFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Factory for building scalar Laplace operator (that is used as fake operator for variable dof size problems) More...

#include <MueLu_VariableDofLaplacianFactory_decl.hpp>

Inheritance diagram for MueLu::VariableDofLaplacianFactory< 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

Public Member Functions

void Build (Level &currentLevel) const
 Build an object with this factory. More...
 
- 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::FancyOStreamGetOStream (MsgType type, int thisProcRankOnly=0) const
 Get an output stream for outputting the input message type. More...
 
Teuchos::FancyOStreamGetBlackHole () 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 VerboseObjectsetVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual const VerboseObjectsetOverridingVerbLevel (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 VerboseObjectBasesetOStream (const RCP< FancyOStream > &oStream) const
 
virtual const VerboseObjectBasesetOverridingOStream (const RCP< FancyOStream > &oStream) const
 
virtual VerboseObjectBasesetLinePrefix (const std::string &linePrefix)
 
virtual RCP< FancyOStreamgetOStream () const
 
virtual RCP< FancyOStreamgetOverridingOStream () 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 ParameterEntryGetParameter (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 buildPaddedMap (const Teuchos::ArrayRCP< const LocalOrdinal > &dofPresent, std::vector< LocalOrdinal > &map, size_t nDofs) const
 
void assignGhostLocalNodeIds (const Teuchos::RCP< const Map > &rowDofMap, const Teuchos::RCP< const Map > &colDofMap, std::vector< LocalOrdinal > &myLocalNodeIds, const std::vector< LocalOrdinal > &dofMap, size_t maxDofPerNode, size_t &nLocalNodes, size_t &nLocalPlusGhostNodes, Teuchos::RCP< const Teuchos::Comm< int > > comm) const
 
void squeezeOutNnzs (Teuchos::ArrayRCP< size_t > &rowPtr, Teuchos::ArrayRCP< LocalOrdinal > &cols, Teuchos::ArrayRCP< Scalar > &vals, const std::vector< bool > &keep) const
 
void buildLaplacian (const Teuchos::ArrayRCP< size_t > &rowPtr, const Teuchos::ArrayRCP< LocalOrdinal > &cols, Teuchos::ArrayRCP< Scalar > &vals, const size_t &numdim, const RCP< Xpetra::MultiVector< typename Teuchos::ScalarTraits< Scalar >::magnitudeType, LocalOrdinal, GlobalOrdinal, Node > > &ghostedCoords) const
 
template<class listType >
void MueLu_az_sort (listType list[], size_t N, size_t list2[], Scalar list3[]) const
 

Constructors/Destructors.

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

Additional Inherited Members

- 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 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...
 
- 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< FancyOStreamgetDefaultOStream ()
 
- 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 = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
class MueLu::VariableDofLaplacianFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Factory for building scalar Laplace operator (that is used as fake operator for variable dof size problems)

Build distance Laplacian associated with input matrix A (which might have a variable number of DOFs per node). Coordinates are needed to calculate the distance laplacian values. The user-provided array "DofPresent" stores whether an array is present (=1) or not (=0) in the matrix. The length of the array is number of nodes * maxDofPerNode and therefore it might be larger or equal than the number of rows in the input matrix.

The factory produces the distance laplacian matrix A as output (with one dof per node) as well as the coarse version of the DofStatus (needed for the next coarser level), containing information about (artificial) Dirichlet rows in the matrix.

Input/output of VariableDofLaplacianFactory

User parameters of VariableDofLaplacianFactory

Parameter type default master.xml validated requested description
A Factory null * * Generating factory of the input matrix A with potentially variable number of DOFs. Might be padded or non-padded. Padded means, that the matrix has additional artificial rows and columns to have a constant number of DOFs per node.
Coordinates Factory null * * Generating factory for Coordinates needed for building distance laplacian.
DofPresent Teuchos::ArrayRCP<LocalOrdinal> NoFactory (*) Optional array containing information whether DOF is actually present in matrix or not.
Advanced Dirichlet: threshold double 1e-5 * Drop tolerance for Dirichlet detection
Variable DOF amalgamation: threshold double 1.8e-9 * Drop tolerance for amalgamation process
maxDofPerNode int 1 * Maximum number of DOFs per node

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 VariableDofLaplacianFactory::GetValidParameters).
The * in the requested column states that the data is requested as input with all dependencies (see VariableDofLaplacianFactory::DeclareInput).

Variables provided by VariableDofLaplacianFactory

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

Parameter generated by description
A VariableDofLaplacianFactory Laplacian operator
DofStatus VariableDofLaplacianFactory Status array for next coarse level

Definition at line 104 of file MueLu_VariableDofLaplacianFactory_decl.hpp.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 72 of file MueLu_VariableDofLaplacianFactory_def.hpp.

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual MueLu::VariableDofLaplacianFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~VariableDofLaplacianFactory ( )
inlinevirtual

Destructor.

Definition at line 117 of file MueLu_VariableDofLaplacianFactory_decl.hpp.

Member Function Documentation

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

Implements MueLu::ParameterListAcceptor.

Definition at line 58 of file MueLu_VariableDofLaplacianFactory_def.hpp.

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

Input.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 75 of file MueLu_VariableDofLaplacianFactory_def.hpp.

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

Build an object with this factory.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 86 of file MueLu_VariableDofLaplacianFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::VariableDofLaplacianFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::buildPaddedMap ( const Teuchos::ArrayRCP< const LocalOrdinal > &  dofPresent,
std::vector< LocalOrdinal > &  map,
size_t  nDofs 
) const
private

Definition at line 469 of file MueLu_VariableDofLaplacianFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::VariableDofLaplacianFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::assignGhostLocalNodeIds ( const Teuchos::RCP< const Map > &  rowDofMap,
const Teuchos::RCP< const Map > &  colDofMap,
std::vector< LocalOrdinal > &  myLocalNodeIds,
const std::vector< LocalOrdinal > &  dofMap,
size_t  maxDofPerNode,
size_t &  nLocalNodes,
size_t &  nLocalPlusGhostNodes,
Teuchos::RCP< const Teuchos::Comm< int > >  comm 
) const
private

Definition at line 477 of file MueLu_VariableDofLaplacianFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::VariableDofLaplacianFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::squeezeOutNnzs ( Teuchos::ArrayRCP< size_t > &  rowPtr,
Teuchos::ArrayRCP< LocalOrdinal > &  cols,
Teuchos::ArrayRCP< Scalar > &  vals,
const std::vector< bool > &  keep 
) const
private

Definition at line 435 of file MueLu_VariableDofLaplacianFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::VariableDofLaplacianFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::buildLaplacian ( const Teuchos::ArrayRCP< size_t > &  rowPtr,
const Teuchos::ArrayRCP< LocalOrdinal > &  cols,
Teuchos::ArrayRCP< Scalar > &  vals,
const size_t &  numdim,
const RCP< Xpetra::MultiVector< typename Teuchos::ScalarTraits< Scalar >::magnitudeType, LocalOrdinal, GlobalOrdinal, Node > > &  ghostedCoords 
) const
private

Definition at line 380 of file MueLu_VariableDofLaplacianFactory_def.hpp.

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
template<class listType >
void MueLu::VariableDofLaplacianFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MueLu_az_sort ( listType  list[],
size_t  N,
size_t  list2[],
Scalar  list3[] 
) const
inlineprivate

Definition at line 140 of file MueLu_VariableDofLaplacianFactory_decl.hpp.


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