Factory to export aggregation info or visualize aggregates using VTK. More...

#include <MueLu_AggregationExportFactory_decl.hpp>

Constructors/Destructors.
	AggregationExportFactory ()
	Constructor. More...

virtual	~AggregationExportFactory ()
	Destructor. More...

RCP< const ParameterList >	GetValidParameterList () const

void	DeclareInput (Level &fineLevel, Level &coarseLevel) const
	Input. More...

Build methods.
static const int	CONTRAST_1_ = -1

static const int	CONTRAST_2_ = -2

static const int	CONTRAST_3_ = -3

Teuchos::ArrayRCP< const double >	xCoords_

Teuchos::ArrayRCP< const double >	yCoords_

Teuchos::ArrayRCP< const double >	zCoords_

Teuchos::ArrayRCP< const double >	cx_

Teuchos::ArrayRCP< const double >	cy_

Teuchos::ArrayRCP< const double >	cz_

Teuchos::ArrayRCP< LocalOrdinal >	vertex2AggId_

Teuchos::ArrayRCP< LocalOrdinal >	aggSizes_

std::vector< bool >	isRoot_

bool	doFineGraphEdges_

bool	doCoarseGraphEdges_

int	numNodes_

int	numAggs_

int	dims_

int	myRank_

Teuchos::RCP< const Map >	nodeMap_

Teuchos::RCP< const Map >	nodeMapCoarse_

int	aggsOffset_

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

void	doJacksPlus_ (std::vector< int > &vertices, std::vector< int > &geomSizes) const

void	doConvexHulls (std::vector< int > &vertices, std::vector< int > &geomSizes) const

void	doAlphaHulls_ (std::vector< int > &vertices, std::vector< int > &geomSizes) const

void	doAlphaHulls2D_ (std::vector< int > &vertices, std::vector< int > &geomSizes) const

void	doAlphaHulls3D_ (std::vector< int > &vertices, std::vector< int > &geomSizes) const

void	doGraphEdges_ (std::ofstream &fout, Teuchos::RCP< Matrix > &A, Teuchos::RCP< GraphBase > &G, bool fine, int dofs) const

void	writeFile_ (std::ofstream &fout, std::string styleName, std::vector< int > &vertices, std::vector< int > &geomSizes) const

void	buildColormap_ () const

void	writePVTU_ (std::ofstream &pvtu, std::string baseFname, int numProcs) const

Detailed Description

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

Factory to export aggregation info or visualize aggregates using VTK.

Note, that some routines only work for 1 dof per node.

Input/output of AggregationExportFactory

User parameters of AggregationExportFactory

Parameter	type	default	validated	requested	description
aggregation: output filename	string		*		filename for VTK-style visualization output
aggregation: output file: time step	int	0	*		time step (overwrites 'TIMESTEP' in output file name)
aggregation: output file: iter	int	0	*		nonlinear iteration (overwrites 'ITER' in output file name)
aggregation: output file: agg style	string	Point Cloud	*		style of aggregation visualization for VTK output. Can be either "Point Cloud", "Jacks", "Convex Hulls" or "Alpha Hulls"
aggregation: output file: fine graph edges	bool	false	*		Draw fine node connections in VTK output (only works for 1 dofs per node!)
aggregation: output file: build colormap	bool	false	*		Output a random color map for paraView in a separate xml file.
Output filename	string		*		Output file name for aggregation data export (outdated, do not use)
Output file: time step	int	0	*		time step variable for output filename (outdated, do not use)
Output file: iter	int	0	*		nonlinear iteration variable for output filename (outdated, do not use)
A	Factory	Teuchos::null	*	*	Factory for A
Coordinates	Factory	Teuchos::null	*	*	Factory for Coordinates (only necessary for vtk output)
Graph	Factory	Teuchos::null	*	*	Factory for Graph of A (only necessary for vtk output)
Aggregates	Factory	Teuchos::null	*	*	Factory for Aggregates
UnAmalgamationInfo	Factory	Teuchos::null	*	*	Factory for UnAmalgamationInfo
DofsPerNode	Factory	Teuchos::null	*	*	Factory for DofsPerNode

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

Definition at line 75 of file MueLu_AggregationExportFactory_decl.hpp.

Constructor & Destructor Documentation

◆ AggregationExportFactory()

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

MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AggregationExportFactory ( )

inline

Constructor.

Definition at line 117 of file MueLu_AggregationExportFactory_decl.hpp.

◆ ~AggregationExportFactory()

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

virtual MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~AggregationExportFactory ( )

inlinevirtual

Destructor.

Definition at line 128 of file MueLu_AggregationExportFactory_decl.hpp.

Member Function Documentation

◆ GetValidParameterList()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

RCP< const ParameterList > MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetValidParameterList

Definition at line 88 of file MueLu_AggregationExportFactory_def.hpp.

◆ DeclareInput()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

Input.

Definition at line 118 of file MueLu_AggregationExportFactory_def.hpp.

◆ Build()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

Build an object with this factory.

Definition at line 140 of file MueLu_AggregationExportFactory_def.hpp.

◆ doJacksPlus_()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doJacksPlus_	(	std::vector< int > &	vertices,
		std::vector< int > &	geomSizes
	)		const

private

Definition at line 370 of file MueLu_AggregationExportFactory_def.hpp.

◆ doConvexHulls()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doConvexHulls	(	std::vector< int > &	vertices,
		std::vector< int > &	geomSizes
	)		const

private

Definition at line 376 of file MueLu_AggregationExportFactory_def.hpp.

◆ doAlphaHulls_()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doAlphaHulls_	(	std::vector< int > &	vertices,
		std::vector< int > &	geomSizes
	)		const

private

Definition at line 386 of file MueLu_AggregationExportFactory_def.hpp.

◆ doAlphaHulls2D_()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doAlphaHulls2D_	(	std::vector< int > &	vertices,
		std::vector< int > &	geomSizes
	)		const

private

Definition at line 396 of file MueLu_AggregationExportFactory_def.hpp.

◆ doAlphaHulls3D_()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doAlphaHulls3D_	(	std::vector< int > &	vertices,
		std::vector< int > &	geomSizes
	)		const

private

Definition at line 456 of file MueLu_AggregationExportFactory_def.hpp.

◆ doGraphEdges_()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doGraphEdges_	(	std::ofstream &	fout,
		Teuchos::RCP< Matrix > &	A,
		Teuchos::RCP< GraphBase > &	G,
		bool	fine,
		int	dofs
	)		const

private

Definition at line 551 of file MueLu_AggregationExportFactory_def.hpp.

◆ writeFile_()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::writeFile_	(	std::ofstream &	fout,
		std::string	styleName,
		std::vector< int > &	vertices,
		std::vector< int > &	geomSizes
	)		const

private

Definition at line 816 of file MueLu_AggregationExportFactory_def.hpp.

◆ buildColormap_()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::buildColormap_

private

Definition at line 933 of file MueLu_AggregationExportFactory_def.hpp.

◆ writePVTU_()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::writePVTU_	(	std::ofstream &	pvtu,
		std::string	baseFname,
		int	numProcs
	)		const

private

Definition at line 960 of file MueLu_AggregationExportFactory_def.hpp.

Member Data Documentation

◆ CONTRAST_1_

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

const int MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CONTRAST_1_ = -1

staticprivate

Definition at line 164 of file MueLu_AggregationExportFactory_decl.hpp.

◆ CONTRAST_2_

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

const int MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CONTRAST_2_ = -2

staticprivate

Definition at line 165 of file MueLu_AggregationExportFactory_decl.hpp.

◆ CONTRAST_3_

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

const int MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CONTRAST_3_ = -3

staticprivate

Definition at line 166 of file MueLu_AggregationExportFactory_decl.hpp.

◆ xCoords_

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

Teuchos::ArrayRCP<const double> MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::xCoords_

mutableprivate

Definition at line 169 of file MueLu_AggregationExportFactory_decl.hpp.

◆ yCoords_

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

Teuchos::ArrayRCP<const double> MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::yCoords_

mutableprivate

Definition at line 170 of file MueLu_AggregationExportFactory_decl.hpp.

◆ zCoords_

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

Teuchos::ArrayRCP<const double> MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::zCoords_

mutableprivate

Definition at line 171 of file MueLu_AggregationExportFactory_decl.hpp.

◆ cx_

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

Teuchos::ArrayRCP<const double> MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::cx_

mutableprivate

Definition at line 172 of file MueLu_AggregationExportFactory_decl.hpp.

◆ cy_

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

Teuchos::ArrayRCP<const double> MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::cy_

mutableprivate

Definition at line 173 of file MueLu_AggregationExportFactory_decl.hpp.

◆ cz_

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

Teuchos::ArrayRCP<const double> MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::cz_

mutableprivate

Definition at line 174 of file MueLu_AggregationExportFactory_decl.hpp.

◆ vertex2AggId_

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

Teuchos::ArrayRCP<LocalOrdinal> MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::vertex2AggId_

mutableprivate

Definition at line 175 of file MueLu_AggregationExportFactory_decl.hpp.

◆ aggSizes_

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

Teuchos::ArrayRCP<LocalOrdinal> MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::aggSizes_

mutableprivate

Definition at line 176 of file MueLu_AggregationExportFactory_decl.hpp.

◆ isRoot_

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

std::vector<bool> MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::isRoot_

mutableprivate

Definition at line 177 of file MueLu_AggregationExportFactory_decl.hpp.

◆ doFineGraphEdges_

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

bool MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doFineGraphEdges_

mutableprivate

Definition at line 178 of file MueLu_AggregationExportFactory_decl.hpp.

◆ doCoarseGraphEdges_

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

bool MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doCoarseGraphEdges_

mutableprivate

Definition at line 179 of file MueLu_AggregationExportFactory_decl.hpp.

◆ numNodes_

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

int MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::numNodes_

mutableprivate

Definition at line 180 of file MueLu_AggregationExportFactory_decl.hpp.

◆ numAggs_

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

int MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::numAggs_

mutableprivate

Definition at line 181 of file MueLu_AggregationExportFactory_decl.hpp.

◆ dims_

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

int MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::dims_

mutableprivate

Definition at line 182 of file MueLu_AggregationExportFactory_decl.hpp.

◆ myRank_

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

int MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::myRank_

mutableprivate

Definition at line 183 of file MueLu_AggregationExportFactory_decl.hpp.

◆ nodeMap_

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

Teuchos::RCP<const Map> MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::nodeMap_

mutableprivate

Definition at line 184 of file MueLu_AggregationExportFactory_decl.hpp.

◆ nodeMapCoarse_

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

Teuchos::RCP<const Map> MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::nodeMapCoarse_

mutableprivate

Definition at line 185 of file MueLu_AggregationExportFactory_decl.hpp.

◆ aggsOffset_

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

int MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::aggsOffset_

mutableprivate

Definition at line 186 of file MueLu_AggregationExportFactory_decl.hpp.

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

Constructors/Destructors.

Build methods.

Detailed Description

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

Input/output of AggregationExportFactory

User parameters of AggregationExportFactory

Constructor & Destructor Documentation

◆ AggregationExportFactory()

◆ ~AggregationExportFactory()

Member Function Documentation

◆ GetValidParameterList()

◆ DeclareInput()

◆ Build()

◆ doJacksPlus_()

◆ doConvexHulls()

◆ doAlphaHulls_()

◆ doAlphaHulls2D_()

◆ doAlphaHulls3D_()

◆ doGraphEdges_()

◆ writeFile_()

◆ buildColormap_()

◆ writePVTU_()

Member Data Documentation

◆ CONTRAST_1_

◆ CONTRAST_2_

◆ CONTRAST_3_

◆ xCoords_

◆ yCoords_

◆ zCoords_

◆ cx_

◆ cy_

◆ cz_

◆ vertex2AggId_

◆ aggSizes_

◆ isRoot_

◆ doFineGraphEdges_

◆ doCoarseGraphEdges_

◆ numNodes_

◆ numAggs_

◆ dims_

◆ myRank_

◆ nodeMap_

◆ nodeMapCoarse_

◆ aggsOffset_

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