Factory for building line detection information. More...

#include <MueLu_LineDetectionFactory_decl.hpp>

Inheritance diagram for MueLu::LineDetectionFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >:

Public Types
using	coordinate_type = typename Teuchos::ScalarTraits< SC >::coordinateType

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

Build methods.
LO	Zorientation_

void	Build (Level &currentLevel) const
	Build method.

void	sort_coordinates (LO numCoords, LO OrigLoc, coordinate_type xvals, coordinate_type yvals, coordinate_type zvals, coordinate_type xtemp, coordinate_type ytemp, coordinate_type *ztemp, bool flipXY=false) const

LO	ML_compute_line_info (LO LayerId[], LO VertLineId[], LO Ndof, LO DofsPerNode, LO MeshNumbering, LO NumNodesPerVertLine, coordinate_type xvals, coordinate_type yvals, coordinate_type *zvals, const Teuchos::Comm< int > &comm) const

void	ML_az_dsort2 (coordinate_type dlist[], LO N, LO list2[]) const

Constructors/Destructors.
	LineDetectionFactory ()

virtual	~LineDetectionFactory ()
	Destructor.

RCP< const ParameterList >	GetValidParameterList () const
	Return a const parameter list of valid parameters that setParameterList() will accept.

void	DeclareInput (Level &currentLevel) const
	Input.

Additional Inherited Members
Public Member Functions inherited from MueLu::SingleLevelFactoryBase
	SingleLevelFactoryBase ()
	Constructor.

virtual	~SingleLevelFactoryBase ()
	Destructor.

virtual void	CallBuild (Level &requestedLevel) const

virtual void	CallDeclareInput (Level &requestedLevel) const

Public Member Functions inherited from MueLu::Factory
	Factory ()
	Constructor.

virtual	~Factory ()
	Destructor.

virtual void	SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)
	Configuration.

const RCP< const FactoryBase >	GetFactory (const std::string &varName) const
	Default implementation of FactoryAcceptor::GetFactory()

RCP< ParameterList >	RemoveFactoriesFromList (const ParameterList &list) const

void	EnableMultipleCallCheck () const

void	DisableMultipleCallCheck () const

void	ResetDebugData () const

Public Member Functions inherited from MueLu::FactoryBase
	FactoryBase ()
	Constructor.

virtual	~FactoryBase ()
	Destructor.

int	GetID () const
	return unique factory id

Public Member Functions inherited from MueLu::BaseClass
virtual	~BaseClass ()
	Destructor.

Public Member Functions inherited from MueLu::VerboseObject
	VerboseObject ()

virtual	~VerboseObject ()
	Destructor.

VerbLevel	GetVerbLevel () const
	Get the verbosity level.

void	SetVerbLevel (const VerbLevel verbLevel)
	Set the verbosity level of this object.

int	GetProcRankVerbose () const
	Get proc rank used for printing. Do not use this information for any other purpose.

int	SetProcRankVerbose (int procRank) const
	Set proc rank used for printing.

bool	IsPrint (MsgType type, int thisProcRankOnly=-1) const
	Find out whether we need to print out information for a specific message type.

Teuchos::FancyOStream &	GetOStream (MsgType type, int thisProcRankOnly=0) const
	Get an output stream for outputting the input message type.

Teuchos::FancyOStream &	GetBlackHole () const

Public Member Functions inherited from MueLu::Describable
virtual	~Describable ()
	Destructor.

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.

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.

virtual std::string	ShortClassName () const
	Return the class name of the object, without template parameters and without namespace.

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.

virtual const Teuchos::ParameterList &	GetParameterList () const

virtual const Teuchos::ParameterList &	GetParameterListWithoutValidation () const

void	SetParameter (const std::string &name, const ParameterEntry &entry)
	Set a parameter directly as a ParameterEntry.

const ParameterEntry &	GetParameter (const std::string &name) const
	Retrieves a const entry with the name name.

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	EnableTimerSync ()

static void	DisableTimerSync ()

static void	EnableMultipleCheckGlobally ()

static void	DisableMultipleCheckGlobally ()

Static Public Member Functions inherited from MueLu::VerboseObject
static void	SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
	Set the default (global) verbosity level.

static VerbLevel	GetDefaultVerbLevel ()
	Get the default (global) verbosity level.

static void	SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream)

static void	SetMueLuOFileStream (const std::string &filename)

static Teuchos::RCP< Teuchos::FancyOStream >	GetMueLuOStream ()

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

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

Detailed Description

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
class MueLu::LineDetectionFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Factory for building line detection information.

Definition at line 35 of file MueLu_LineDetectionFactory_decl.hpp.

Member Typedef Documentation

◆ coordinate_type

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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

Definition at line 40 of file MueLu_LineDetectionFactory_decl.hpp.

◆ CoordinateMultiVector

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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

Definition at line 41 of file MueLu_LineDetectionFactory_decl.hpp.

Constructor & Destructor Documentation

◆ LineDetectionFactory()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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

inline

Definition at line 46 of file MueLu_LineDetectionFactory_decl.hpp.

◆ ~LineDetectionFactory()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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

inlinevirtual

Destructor.

Definition at line 50 of file MueLu_LineDetectionFactory_decl.hpp.

Member Function Documentation

◆ GetValidParameterList()

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

RCP< const ParameterList > MueLu::LineDetectionFactory< 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 25 of file MueLu_LineDetectionFactory_def.hpp.

◆ DeclareInput()

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

void MueLu::LineDetectionFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level & currentLevel ) const

virtual

Input.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 40 of file MueLu_LineDetectionFactory_def.hpp.

◆ Build()

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

void MueLu::LineDetectionFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Build ( Level & currentLevel ) const

virtual

Build method.

Builds line detection information and stores it in currentLevel

Implements MueLu::SingleLevelFactoryBase.

Definition at line 55 of file MueLu_LineDetectionFactory_def.hpp.

◆ sort_coordinates()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

void MueLu::LineDetectionFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::sort_coordinates	(	LO	numCoords,
		LO *	OrigLoc,
		coordinate_type *	xvals,
		coordinate_type *	yvals,
		coordinate_type *	zvals,
		coordinate_type *	xtemp,
		coordinate_type *	ytemp,
		coordinate_type *	ztemp,
		bool	flipXY = `false`
	)		const

private

Definition at line 333 of file MueLu_LineDetectionFactory_def.hpp.

◆ ML_compute_line_info()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

LocalOrdinal MueLu::LineDetectionFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ML_compute_line_info	(	LO	LayerId[],
		LO	VertLineId[],
		LO	Ndof,
		LO	DofsPerNode,
		LO	MeshNumbering,
		LO	NumNodesPerVertLine,
		coordinate_type *	xvals,
		coordinate_type *	yvals,
		coordinate_type *	zvals,
		const Teuchos::Comm< int > &	comm
	)		const

private

Definition at line 226 of file MueLu_LineDetectionFactory_def.hpp.

◆ ML_az_dsort2()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

void MueLu::LineDetectionFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ML_az_dsort2	(	coordinate_type	dlist[],
		LO	N,
		LO	list2[]
	)		const

private

Definition at line 379 of file MueLu_LineDetectionFactory_def.hpp.

Member Data Documentation

◆ Zorientation_

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

LO MueLu::LineDetectionFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Zorientation_

mutableprivate

internally stores line detection mode can be either vertical, horizontal or coordinates for the first run. On the coarser levels we automatically switch to vertical mode

Definition at line 97 of file MueLu_LineDetectionFactory_decl.hpp.

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

Public Types

Build methods.

Constructors/Destructors.

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ coordinate_type

◆ CoordinateMultiVector

Constructor & Destructor Documentation

◆ LineDetectionFactory()

◆ ~LineDetectionFactory()

Member Function Documentation

◆ GetValidParameterList()

◆ DeclareInput()

◆ Build()

◆ sort_coordinates()

◆ ML_compute_line_info()

◆ ML_az_dsort2()

Member Data Documentation

◆ Zorientation_