Short class definition. More...

#include <parallel_distance_calculation_process.h>

Inheritance diagram for Kratos::ParallelDistanceCalculationProcess< TDim >:

Collaboration diagram for Kratos::ParallelDistanceCalculationProcess< TDim >:

Public Member Functions
Life Cycle
	ParallelDistanceCalculationProcess (ModelPart &rModelPart, Parameters Settings)

	ParallelDistanceCalculationProcess (Model &rModel, Parameters Settings)

	ParallelDistanceCalculationProcess (ParallelDistanceCalculationProcess< TDim > const &rOther)=delete
	Copy constructor. More...

virtual	~ParallelDistanceCalculationProcess ()
	Destructor. More...

const Parameters	GetDefaultParameters () const override
	This method provides the defaults parameters to avoid conflicts between the different constructors. More...

int	Check () override
	This function is designed for being called after ExecuteInitialize ONCE to verify that the input is correct. More...

void	Execute () override
	Execute method is used to execute the Process algorithms. More...

double	FindMaximumEdgeSize ()

Input and output
std::string	Info () const override
	Turn back information as a string. More...

void	PrintInfo (std::ostream &rOStream) const override
	Print information about this object. More...

void	PrintData (std::ostream &rOStream) const override
	Print object's data. More...

Public Member Functions inherited from Kratos::Process
	KRATOS_CLASS_POINTER_DEFINITION (Process)
	Pointer definition of Process. More...

	Process ()
	Default constructor. More...

	Process (const Flags options)

	~Process () override
	Destructor. More...

void	operator() ()
	This operator is provided to call the process as a function and simply calls the Execute method. More...

virtual Process::Pointer	Create (Model &rModel, Parameters ThisParameters)
	This method creates an pointer of the process. More...

virtual void	ExecuteInitialize ()
	This function is designed for being called at the beginning of the computations right after reading the model and the groups. More...

virtual void	ExecuteBeforeSolutionLoop ()
	This function is designed for being execute once before the solution loop but after all of the solvers where built. More...

virtual void	ExecuteInitializeSolutionStep ()
	This function will be executed at every time step BEFORE performing the solve phase. More...

virtual void	ExecuteFinalizeSolutionStep ()
	This function will be executed at every time step AFTER performing the solve phase. More...

virtual void	ExecuteBeforeOutputStep ()
	This function will be executed at every time step BEFORE writing the output. More...

virtual void	ExecuteAfterOutputStep ()
	This function will be executed at every time step AFTER writing the output. More...

virtual void	ExecuteFinalize ()
	This function is designed for being called at the end of the computations. More...

virtual void	Clear ()
	This method clears the assignation of the conditions. More...

std::string	Info () const override
	Turn back information as a string. More...

void	PrintInfo (std::ostream &rOStream) const override
	Print information about this object. More...

void	PrintData (std::ostream &rOStream) const override
	Print object's data. More...

Public Member Functions inherited from Kratos::Flags
Flags &	operator= (Flags const &rOther)
	Assignment operator. More...

	operator bool () const

Flags	operator~ () const

bool	operator! () const

void	AssignFlags (Flags const &rOther)

void	Set (const Flags ThisFlag)

void	Set (const Flags ThisFlag, bool Value)

void	Reset (const Flags ThisFlag)

void	Flip (const Flags ThisFlag)

void	SetPosition (IndexType Position, bool Value=true)

bool	GetPosition (IndexType Position) const

void	FlipPosition (IndexType Position)

void	ClearPosition (IndexType Position)

void	Clear ()

Flags	AsFalse () const

bool	Is (Flags const &rOther) const

bool	IsDefined (Flags const &rOther) const

bool	IsNot (Flags const &rOther) const

bool	IsNotDefined (Flags const &rOther) const

	KRATOS_CLASS_POINTER_DEFINITION (Flags)
	Pointer definition of Flags. More...

const Flags &	operator\|= (const Flags &Other)

const Flags &	operator&= (const Flags &Other)

	Flags ()
	Default constructor. More...

	Flags (Flags const &rOther)
	Copy constructor. More...

virtual	~Flags ()
	Destructor. More...

Protected Attributes
Protected member Variables
ModelPart &	mrModelPart

const Variable< double > *	mpDistanceVar

const Variable< double > *	mpAreaVar

unsigned int	mMaxLevels

double	mMaxDistance

bool	mCalculateExactDistancesToPlane

Type Definitions
enum class	NodalDatabase { NodeHistorical , NodeNonHistorical }
	Nodal databases auxiliary enum. More...

using	NodeType = typename ModelPart::NodeType
	Node type from model part. More...

using	NodeScalarGetFunctionType = std::function< double &(NodeType &rNode)>
	Lambda type to retrieve a scalar variable from a node. More...

	KRATOS_CLASS_POINTER_DEFINITION (ParallelDistanceCalculationProcess)
	Pointer definition of ParallelDistanceCalculationProcess. More...

Additional Inherited Members
Public Types inherited from Kratos::Flags
enum	FlagsList { Flag0 = BlockType(1) , Flag1 = BlockType(1) << 1 , Flag2 = BlockType(1) << 2 , Flag3 = BlockType(1) << 3 , Flag4 = BlockType(1) << 4 , Flag5 = BlockType(1) << 5 , Flag6 = BlockType(1) << 6 , Flag7 = BlockType(1) << 7 , Flag8 = BlockType(1) << 8 , Flag9 = BlockType(1) << 9 , Flag10 = BlockType(1) << 10 , Flag11 = BlockType(1) << 11 , Flag12 = BlockType(1) << 12 , Flag13 = BlockType(1) << 13 , Flag14 = BlockType(1) << 14 , Flag15 = BlockType(1) << 15 , Flag16 = BlockType(1) << 16 , Flag17 = BlockType(1) << 17 , Flag18 = BlockType(1) << 18 , Flag19 = BlockType(1) << 19 , Flag20 = BlockType(1) << 20 , Flag21 = BlockType(1) << 21 , Flag22 = BlockType(1) << 22 , Flag23 = BlockType(1) << 23 , Flag24 = BlockType(1) << 24 , Flag25 = BlockType(1) << 25 , Flag26 = BlockType(1) << 26 , Flag27 = BlockType(1) << 27 , Flag28 = BlockType(1) << 28 , Flag29 = BlockType(1) << 29 , Flag30 = BlockType(1) << 30 }

typedef int64_t	BlockType

typedef int64_t	FlagType

typedef std::size_t	IndexType

Static Public Member Functions inherited from Kratos::Flags
static const Flags	AllDefined ()

static const Flags	AllTrue ()

static Flags	Create (IndexType ThisPosition, bool Value=true)

Detailed Description

template<unsigned int TDim>
class Kratos::ParallelDistanceCalculationProcess< TDim >

Short class definition.

Detail class definition.

Member Typedef Documentation

◆ NodeScalarGetFunctionType

template<unsigned int TDim>

using Kratos::ParallelDistanceCalculationProcess< TDim >::NodeScalarGetFunctionType = std::function<double&(NodeType& rNode)>

Lambda type to retrieve a scalar variable from a node.

◆ NodeType

template<unsigned int TDim>

using Kratos::ParallelDistanceCalculationProcess< TDim >::NodeType = typename ModelPart::NodeType

Node type from model part.

Member Enumeration Documentation

◆ NodalDatabase

template<unsigned int TDim>

enum Kratos::ParallelDistanceCalculationProcess::NodalDatabase

strong

Nodal databases auxiliary enum.

Enumerator
NodeHistorical
NodeNonHistorical

Constructor & Destructor Documentation

◆ ParallelDistanceCalculationProcess() [1/3]

template<unsigned int TDim>

Kratos::ParallelDistanceCalculationProcess< TDim >::ParallelDistanceCalculationProcess	(	ModelPart &	rModelPart,
		Parameters	Settings
	)

◆ ParallelDistanceCalculationProcess() [2/3]

template<unsigned int TDim>

Kratos::ParallelDistanceCalculationProcess< TDim >::ParallelDistanceCalculationProcess	(	Model &	rModel,
		Parameters	Settings
	)

◆ ParallelDistanceCalculationProcess() [3/3]

template<unsigned int TDim>

Kratos::ParallelDistanceCalculationProcess< TDim >::ParallelDistanceCalculationProcess ( ParallelDistanceCalculationProcess< TDim > const & rOther )

delete

Copy constructor.

◆ ~ParallelDistanceCalculationProcess()

template<unsigned int TDim>

virtual Kratos::ParallelDistanceCalculationProcess< TDim >::~ParallelDistanceCalculationProcess ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ Check()

template<unsigned int TDim>

int Kratos::ParallelDistanceCalculationProcess< TDim >::Check

overridevirtual

This function is designed for being called after ExecuteInitialize ONCE to verify that the input is correct.

Reimplemented from Kratos::Process.

◆ Execute()

template<unsigned int TDim>

void Kratos::ParallelDistanceCalculationProcess< TDim >::Execute

overridevirtual

Execute method is used to execute the Process algorithms.

Reimplemented from Kratos::Process.

◆ FindMaximumEdgeSize()

template<unsigned int TDim>

double Kratos::ParallelDistanceCalculationProcess< TDim >::FindMaximumEdgeSize

◆ GetDefaultParameters()

template<unsigned int TDim>

const Parameters Kratos::ParallelDistanceCalculationProcess< TDim >::GetDefaultParameters

overridevirtual

This method provides the defaults parameters to avoid conflicts between the different constructors.

Reimplemented from Kratos::Process.

◆ Info()

template<unsigned int TDim>

std::string Kratos::ParallelDistanceCalculationProcess< TDim >::Info ( ) const

inlineoverridevirtual

Turn back information as a string.

Reimplemented from Kratos::Flags.

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<unsigned int TDim>

Kratos::ParallelDistanceCalculationProcess< TDim >::KRATOS_CLASS_POINTER_DEFINITION ( ParallelDistanceCalculationProcess< TDim > )

Pointer definition of ParallelDistanceCalculationProcess.

◆ PrintData()

template<unsigned int TDim>

void Kratos::ParallelDistanceCalculationProcess< TDim >::PrintData ( std::ostream & rOStream ) const

inlineoverridevirtual

Print object's data.

Reimplemented from Kratos::Flags.

◆ PrintInfo()

template<unsigned int TDim>

void Kratos::ParallelDistanceCalculationProcess< TDim >::PrintInfo ( std::ostream & rOStream ) const

inlineoverridevirtual

Print information about this object.

Reimplemented from Kratos::Flags.

Member Data Documentation

◆ mCalculateExactDistancesToPlane

template<unsigned int TDim>

bool Kratos::ParallelDistanceCalculationProcess< TDim >::mCalculateExactDistancesToPlane

protected

◆ mMaxDistance

template<unsigned int TDim>

double Kratos::ParallelDistanceCalculationProcess< TDim >::mMaxDistance

protected

◆ mMaxLevels

template<unsigned int TDim>

unsigned int Kratos::ParallelDistanceCalculationProcess< TDim >::mMaxLevels

protected

◆ mpAreaVar

template<unsigned int TDim>

const Variable<double>* Kratos::ParallelDistanceCalculationProcess< TDim >::mpAreaVar

protected

◆ mpDistanceVar

template<unsigned int TDim>

const Variable<double>* Kratos::ParallelDistanceCalculationProcess< TDim >::mpDistanceVar

protected

◆ mrModelPart

template<unsigned int TDim>

ModelPart& Kratos::ParallelDistanceCalculationProcess< TDim >::mrModelPart

protected

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

/home/runner/work/Documentation/Documentation/master/kratos/processes/parallel_distance_calculation_process.h
/home/runner/work/Documentation/Documentation/master/kratos/processes/parallel_distance_calculation_process.cpp

Public Member Functions

Protected Attributes

Type Definitions

Additional Inherited Members

Detailed Description

template<unsigned int TDim> class Kratos::ParallelDistanceCalculationProcess< TDim >

Member Typedef Documentation

◆ NodeScalarGetFunctionType

◆ NodeType

Member Enumeration Documentation

◆ NodalDatabase

Constructor & Destructor Documentation

◆ ParallelDistanceCalculationProcess() [1/3]

◆ ParallelDistanceCalculationProcess() [2/3]

◆ ParallelDistanceCalculationProcess() [3/3]

◆ ~ParallelDistanceCalculationProcess()

Member Function Documentation

◆ Check()

◆ Execute()

◆ FindMaximumEdgeSize()

◆ GetDefaultParameters()

◆ Info()

◆ KRATOS_CLASS_POINTER_DEFINITION()

◆ PrintData()

◆ PrintInfo()

Member Data Documentation

◆ mCalculateExactDistancesToPlane

◆ mMaxDistance

◆ mMaxLevels

◆ mpAreaVar

◆ mpDistanceVar

◆ mrModelPart

template<unsigned int TDim>
class Kratos::ParallelDistanceCalculationProcess< TDim >