Computes DISTANCE from a path model part to a given model part. More...

#include <calculate_distance_to_path_process.h>

Inheritance diagram for Kratos::CalculateDistanceToPathProcess< THistorical >:

Collaboration diagram for Kratos::CalculateDistanceToPathProcess< THistorical >:

Public Member Functions
Life Cycle
	CalculateDistanceToPathProcess (Model &rModel, Parameters ThisParameters)
	Default constructor. More...

	~CalculateDistanceToPathProcess () override
	Destructor. More...

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

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

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

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 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 int	Check ()
	This function is designed for being called after ExecuteInitialize ONCE to verify that the input is correct. 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...

Type Definitions
typedef std::size_t	IndexType
	Index type definition. More...

typedef std::size_t	SizeType
	Size type definition. More...

typedef Node	NodeType
	The definition of the node. More...

	KRATOS_CLASS_POINTER_DEFINITION (CalculateDistanceToPathProcess)
	Pointer definition of CalculateDistanceToPathProcess. 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<bool THistorical = true>
class Kratos::CalculateDistanceToPathProcess< THistorical >

Computes DISTANCE from a path model part to a given model part.

Author: Vicente Mataix Ferrandiz

Template Parameters

THistorical If the distance is computed as historical or non historical variable

Member Typedef Documentation

◆ IndexType

template<bool THistorical = true>

typedef std::size_t Kratos::CalculateDistanceToPathProcess< THistorical >::IndexType

Index type definition.

◆ NodeType

template<bool THistorical = true>

typedef Node Kratos::CalculateDistanceToPathProcess< THistorical >::NodeType

The definition of the node.

◆ SizeType

template<bool THistorical = true>

typedef std::size_t Kratos::CalculateDistanceToPathProcess< THistorical >::SizeType

Size type definition.

Constructor & Destructor Documentation

◆ CalculateDistanceToPathProcess()

template<bool THistorical>

Kratos::CalculateDistanceToPathProcess< THistorical >::CalculateDistanceToPathProcess	(	Model &	rModel,
		Parameters	ThisParameters
	)

Default constructor.

Parameters

rModel The model containing the model parts

◆ ~CalculateDistanceToPathProcess()

template<bool THistorical = true>

Kratos::CalculateDistanceToPathProcess< THistorical >::~CalculateDistanceToPathProcess ( )

inlineoverride

Destructor.

Member Function Documentation

◆ Create()

template<bool THistorical = true>

Process::Pointer Kratos::CalculateDistanceToPathProcess< THistorical >::Create	(	Model &	rModel,
		Parameters	ThisParameters
	)

inlineoverridevirtual

This method creates an pointer of the process.

We consider as input a Model and a set of Parameters for the sake of generality

Warning: Must be overrided in each process implementation

Parameters

rModel	The model to be consider
ThisParameters	The configuration parameters

Reimplemented from Kratos::Process.

◆ Execute()

template<bool THistorical>

void Kratos::CalculateDistanceToPathProcess< THistorical >::Execute

overridevirtual

Execute method is used to execute the Process algorithms.

Reimplemented from Kratos::Process.

◆ GetDefaultParameters()

template<bool THistorical>

const Parameters Kratos::CalculateDistanceToPathProcess< THistorical >::GetDefaultParameters

overridevirtual

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

Reimplemented from Kratos::Process.

◆ Info()

template<bool THistorical = true>

std::string Kratos::CalculateDistanceToPathProcess< THistorical >::Info ( ) const

inlineoverridevirtual

Turn back information as a string.

Reimplemented from Kratos::Flags.

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<bool THistorical = true>

Kratos::CalculateDistanceToPathProcess< THistorical >::KRATOS_CLASS_POINTER_DEFINITION ( CalculateDistanceToPathProcess< THistorical > )

Pointer definition of CalculateDistanceToPathProcess.

◆ PrintData()

template<bool THistorical = true>

void Kratos::CalculateDistanceToPathProcess< THistorical >::PrintData ( std::ostream & rOStream ) const

inlineoverridevirtual

Print object's data.

Reimplemented from Kratos::Flags.

◆ PrintInfo()

template<bool THistorical = true>

void Kratos::CalculateDistanceToPathProcess< THistorical >::PrintInfo ( std::ostream & rOStream ) const

inlineoverridevirtual

Print information about this object.

Reimplemented from Kratos::Flags.

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

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

Public Member Functions

Type Definitions

Additional Inherited Members

Detailed Description

template<bool THistorical = true> class Kratos::CalculateDistanceToPathProcess< THistorical >

Member Typedef Documentation

◆ IndexType

◆ NodeType

◆ SizeType

Constructor & Destructor Documentation

◆ CalculateDistanceToPathProcess()

◆ ~CalculateDistanceToPathProcess()

Member Function Documentation

◆ Create()

◆ Execute()

◆ GetDefaultParameters()

◆ Info()

◆ KRATOS_CLASS_POINTER_DEFINITION()

◆ PrintData()

◆ PrintInfo()

template<bool THistorical = true>
class Kratos::CalculateDistanceToPathProcess< THistorical >