MueLu  Version of the Day
List of all members
MueLu::CoarseningVisualizationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Factory to visualize coarsening information using prolongation operators. More...

#include <MueLu_CoarseningVisualizationFactory_decl.hpp>

Constructors/Destructors.

 CoarseningVisualizationFactory ()
 Constructor. More...
 
virtual ~CoarseningVisualizationFactory ()
 Destructor. More...
 
RCP< const ParameterList > GetValidParameterList () const
 
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...
 

Detailed Description

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

Factory to visualize coarsening information using prolongation operators.

Input/output of CoarseningVisualizationFactory

User parameters of CoarseningVisualizationFactory

Parameter type default master.xml validated requested description
visualization: output filename string vizLEVELID * filename for VTK-style visualization output
visualization: output file: time step int 0 * time step (overwrites 'TIMESTEP' in output file name)
visualization: output file: iter int 0 * nonlinear iteration (overwrites 'ITER' in output file name)
visualization: style string Point Cloud * style of aggregation visualization for VTK output. Can be either "Point Cloud", "Jacks", "Convex Hulls" or "Alpha Hulls"
visualization: fine graph edges bool false * Draw fine node connections in VTK output (only works for 1 dofs per node!)
visualization: build colormap bool false * Output a random color map for paraView in a separate xml file.
P Factory Teuchos::null * * Prolongator factory. The user has to declare either P or Ptent but not both at the same time.
Ptent Factory Teuchos::null * * Tentative prolongator factory. The user has to declare either P or Ptent but not both at the same time.
Coordinates Factory Teuchos::null * * Factory for Coordinates on fine level
Graph Factory Teuchos::null * * Factory for Graph of A

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

Definition at line 63 of file MueLu_CoarseningVisualizationFactory_decl.hpp.

Constructor & Destructor Documentation

◆ CoarseningVisualizationFactory()

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

Constructor.

Definition at line 99 of file MueLu_CoarseningVisualizationFactory_decl.hpp.

◆ ~CoarseningVisualizationFactory()

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

Destructor.

Definition at line 102 of file MueLu_CoarseningVisualizationFactory_decl.hpp.

Member Function Documentation

◆ GetValidParameterList()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const ParameterList > MueLu::CoarseningVisualizationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetValidParameterList

Definition at line 60 of file MueLu_CoarseningVisualizationFactory_def.hpp.

◆ DeclareInput()

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

Input.

Definition at line 75 of file MueLu_CoarseningVisualizationFactory_def.hpp.

◆ Build()

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

Build an object with this factory.

Definition at line 101 of file MueLu_CoarseningVisualizationFactory_def.hpp.

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