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

#include <MueLu_AggregationExportFactory_fwd.hpp>

Inheritance diagram for MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, 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::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 FactoryBase >	GetFactory (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 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 ()

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

Public Member Functions inherited from MueLu::VisualizationHelpers< Scalar, LocalOrdinal, GlobalOrdinal, Node >
RCP< ParameterList >	GetValidParameterList () const

	VisualizationHelpers ()
	Constructor. More...

virtual	~VisualizationHelpers ()
	Destructor. More...

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

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

void	doGraphEdges_ (std::ofstream &fout, Teuchos::RCP< Matrix > &A, Teuchos::RCP< LWGraph > &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

Private Attributes
Teuchos::RCP < CoordinateMultiVector >	coords_

Teuchos::RCP < CoordinateMultiVector >	coordsCoarse_

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_

Static Private Attributes
static const int	CONTRAST_1_ = -1

static const int	CONTRAST_2_ = -2

static const int	CONTRAST_3_ = -3

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

virtual	~AggregationExportFactory ()
	Destructor. More...

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

Build methods.
using	coordinate_type = typename Teuchos::ScalarTraits< SC >::coordinateType

using	CoordinateMultiVector = typename Xpetra::MultiVector< coordinate_type, LO, GO, NO >

void	Build (Level &fineLevel, Level &coarseLevel) const
	Build an object with this factory. 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...

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 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 >
T	Get (Level &level, const std::string &varName) const

template<class T >
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

template<class T >
bool	IsType (Level &level, const std::string &varName) const

bool	IsAvailable (Level &level, const std::string &varName) const

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

Protected Member Functions inherited from MueLu::VisualizationHelpers< Scalar, LocalOrdinal, GlobalOrdinal, Node >
void	writeFileVTKOpening (std::ofstream &fout, std::vector< int > &uniqueFine, std::vector< int > &geomSizesFine) const

void	writeFileVTKNodes (std::ofstream &fout, std::vector< int > &uniqueFine, Teuchos::RCP< const Map > &nodeMap) const

void	writeFileVTKData (std::ofstream &fout, std::vector< int > &uniqueFine, LocalOrdinal myAggOffset, ArrayRCP< LocalOrdinal > &vertex2AggId, int myRank) const

void	writeFileVTKCoordinates (std::ofstream &fout, std::vector< int > &uniqueFine, Teuchos::ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > &fx, Teuchos::ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > &fy, Teuchos::ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > &fz, int dim) const

void	writeFileVTKCells (std::ofstream &fout, std::vector< int > &uniqueFine, std::vector< LocalOrdinal > &vertices, std::vector< LocalOrdinal > &geomSize) const

void	writeFileVTKClosing (std::ofstream &fout) const

void	writePVTU (std::ofstream &pvtu, std::string baseFname, int numProcs, bool bFineEdges=false, bool bCoarseEdges=false) const

void	buildColormap () const

std::string	getFileName (int numProcs, int myRank, int level, const Teuchos::ParameterList &pL) const

std::string	getBaseFileName (int numProcs, int level, const Teuchos::ParameterList &pL) const

std::string	getPVTUFileName (int numProcs, int myRank, int level, const Teuchos::ParameterList &pL) const

std::string	replaceAll (std::string result, const std::string &replaceWhat, const std::string &replaceWithWhat) const

std::vector< int >	makeUnique (std::vector< int > &vertices) const
	replaces node indices in vertices with compressed unique indices, and returns list of unique points More...

Static Protected Member Functions inherited from MueLu::VisualizationHelpers< Scalar, LocalOrdinal, GlobalOrdinal, Node >
static void	doPointCloud (std::vector< int > &vertices, std::vector< int > &geomSizes, LO numLocalAggs, LO numFineNodes)

static void	doJacks (std::vector< int > &vertices, std::vector< int > &geomSizes, LO numLocalAggs, LO numFineNodes, const std::vector< bool > &isRoot, const ArrayRCP< LO > &vertex2AggId)

static void	doConvexHulls2D (std::vector< int > &vertices, std::vector< int > &geomSizes, LO numLocalAggs, LO numFineNodes, const std::vector< bool > &isRoot, const ArrayRCP< LO > &vertex2AggId, const Teuchos::ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > &xCoords, const Teuchos::ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > &yCoords)

static void	doConvexHulls3D (std::vector< int > &vertices, std::vector< int > &geomSizes, LO numLocalAggs, LO numFineNodes, const std::vector< bool > &isRoot, const ArrayRCP< LO > &vertex2AggId, const Teuchos::ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > &xCoords, const Teuchos::ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > &yCoords, const Teuchos::ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > &zCoords)

static void	doGraphEdges (std::vector< int > &vertices, std::vector< int > &geomSizes, Teuchos::RCP< LWGraph > &G, Teuchos::ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > &fx, Teuchos::ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > &fy, Teuchos::ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > &fz)

static int	ccw (const myVec2 &a, const myVec2 &b, const myVec2 &c)

static myVec3	crossProduct (myVec3 v1, myVec3 v2)

static double	dotProduct (myVec2 v1, myVec2 v2)

static double	dotProduct (myVec3 v1, myVec3 v2)

static bool	isInFront (myVec3 point, myVec3 inPlane, myVec3 n)

static double	mymagnitude (myVec2 vec)

static double	mymagnitude (myVec3 vec)

static double	distance (myVec2 p1, myVec2 p2)

static double	distance (myVec3 p1, myVec3 p2)

static myVec2	vecSubtract (myVec2 v1, myVec2 v2)

static myVec3	vecSubtract (myVec3 v1, myVec3 v2)

static myVec2	getNorm (myVec2 v)

static myVec3	getNorm (myVec3 v1, myVec3 v2, myVec3 v3)

static double	pointDistFromTri (myVec3 point, myVec3 v1, myVec3 v2, myVec3 v3)

static std::vector< myTriangle >	processTriangle (std::list< myTriangle > &tris, myTriangle tri, std::list< int > &pointsInFront, myVec3 &barycenter, const Teuchos::ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > &xCoords, const Teuchos::ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > &yCoords, const Teuchos::ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > &zCoords)

static std::vector< int >	giftWrap (std::vector< myVec2 > &points, std::vector< int > &nodes, const Teuchos::ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > &xCoords, const Teuchos::ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > &yCoords)

Static Protected Attributes inherited from MueLu::Factory
static bool	timerSync_ = false

Detailed Description

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
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", or "Convex 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 15 of file MueLu_AggregationExportFactory_fwd.hpp.

Member Typedef Documentation

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

using MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::coordinate_type = typename Teuchos::ScalarTraits<SC>::coordinateType

Definition at line 103 of file MueLu_AggregationExportFactory_decl.hpp.

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

using MueLu::AggregationExportFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CoordinateMultiVector = typename Xpetra::MultiVector<coordinate_type, LO, GO, NO>

Definition at line 104 of file MueLu_AggregationExportFactory_decl.hpp.

Constructor & Destructor Documentation

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

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

Constructor.

Definition at line 42 of file MueLu_AggregationExportFactory_def.hpp.

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

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

virtualdefault

Destructor.

Member Function Documentation

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

RCP< const ParameterList > MueLu::AggregationExportFactory< 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 55 of file MueLu_AggregationExportFactory_def.hpp.

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

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

virtual

Input.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 86 of file MueLu_AggregationExportFactory_def.hpp.

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

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

virtual

Build an object with this factory.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 106 of file MueLu_AggregationExportFactory_def.hpp.

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 298 of file MueLu_AggregationExportFactory_def.hpp.

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 303 of file MueLu_AggregationExportFactory_def.hpp.

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< LWGraph > &	G,
		bool	fine,
		int	dofs
	)		const

private

Definition at line 317 of file MueLu_AggregationExportFactory_def.hpp.

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 565 of file MueLu_AggregationExportFactory_def.hpp.

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

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

private

Definition at line 688 of file MueLu_AggregationExportFactory_def.hpp.

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