The base class for all processes in Kratos. More...

#include <process.h>

Collaboration diagram for Kratos::Process:

Public Member Functions
Type Definitions
	KRATOS_CLASS_POINTER_DEFINITION (Process)
	Pointer definition of Process. More...

Life Cycle
	Process ()
	Default constructor. More...

	Process (const Flags options)

	~Process () override
	Destructor. More...

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

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

virtual void	Execute ()
	Execute method is used to execute the Process algorithms. 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...

virtual const Parameters	GetDefaultParameters () const
	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::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...

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

The base class for all processes in Kratos.

The process is the base class for all processes and defines a simple interface for them. Execute method is used to execute the Process algorithms. While the parameters of this method can be very different from one Process to other there is no way to create enough overridden versions of it. For this reason this method takes no argument and all Process parameters must be passed at construction time. The reason is that each constructor can take different set of argument without any dependency to other processes or the base Process class.

Author: Pooyan Dadvand; Riccardo Rossi

Constructor & Destructor Documentation

◆ Process() [1/2]

Kratos::Process::Process ( )

inline

Default constructor.

◆ Process() [2/2]

Kratos::Process::Process ( const Flags options )

inlineexplicit

◆ ~Process()

Kratos::Process::~Process ( )

inlineoverride

Destructor.

Member Function Documentation

◆ Check()

virtual int Kratos::Process::Check ( )

inlinevirtual

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

Reimplemented in Kratos::TimeAveragingProcess, Kratos::StructuredMeshGeneratorProcess, Kratos::ParallelDistanceCalculationProcess< TDim >, Kratos::FromJSONCheckResultProcess, Kratos::EdgeBasedGradientRecoveryProcess< TDataType, TSparseSpace, TDenseSpace, TLinearSolver >, Kratos::WriteFromSwAtInterfaceProcess< TDim >, Kratos::DepthIntegrationProcess< TDim >, Kratos::CalculateDistanceToBoundaryProcess, Kratos::ApplySinusoidalFunctionProcess< TVarType >, Kratos::ApplyPerturbationFunctionProcess< TVarType >, Kratos::RansWallFunctionUpdateProcess, Kratos::RansWallDistanceCalculationProcess, Kratos::RansOmegaTurbulentMixingLengthInletProcess, Kratos::RansNutYPlusWallFunctionUpdateProcess, Kratos::RansNutNodalUpdateProcess, Kratos::RansNutKOmegaUpdateProcess, Kratos::RansNutKOmegaSSTUpdateProcess, Kratos::RansNutKEpsilonUpdateProcess, Kratos::RansLineOutputProcess, Kratos::RansKTurbulentIntensityInletProcess, Kratos::RansEpsilonTurbulentMixingLengthInletProcess, Kratos::RansComputeReactionsProcess, Kratos::RansClipScalarVariableProcess, Kratos::MultiscaleRefiningProcess, Kratos::ShockCapturingPhysicsBasedProcess, Kratos::ShockCapturingEntropyViscosityProcess, Kratos::EmbeddedSkinVisualizationProcess, and Kratos::ComputeYPlusProcess.

◆ Clear()

virtual void Kratos::Process::Clear ( )

inlinevirtual

This method clears the assignation of the conditions.

Reimplemented in Kratos::VariationalDistanceCalculationProcess< TDim, TSparseSpace, TDenseSpace, TLinearSolver >, Kratos::LevelSetConvectionProcess< TDim, TSparseSpace, TDenseSpace, TLinearSolver >, Kratos::FluxCorrectedTransportConvectionProcess< TDim >, Kratos::FindIntersectedGeometricalObjectsProcess, Kratos::FindGlobalNodalEntityNeighboursProcess< TContainerType >, Kratos::FindGlobalNodalEntityNeighboursProcess< ModelPart::ElementsContainerType >, Kratos::EdgeBasedGradientRecoveryProcess< TDataType, TSparseSpace, TDenseSpace, TLinearSolver >, Kratos::CalculateEmbeddedSignedDistanceTo3DSkinProcess, Kratos::CalculateEmbeddedNodalVariableFromSkinProcess< TVarType, TSparseSpace, TDenseSpace, TLinearSolver >, Kratos::CalculateDiscontinuousDistanceToSkinProcess< TDim >, Kratos::CalculateDiscontinuousDistanceToSkinProcess< 3 >, Kratos::StokesInitializationProcess< TSparseSpace, TDenseSpace, TLinearSolver >, and Kratos::DistanceSmoothingProcess< TDim, TSparseSpace, TDenseSpace, TLinearSolver >.

◆ Create()

virtual Process::Pointer Kratos::Process::Create	(	Model &	rModel,
		Parameters	ThisParameters
	)

inlinevirtual

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 in Kratos::ReplaceElementsAndConditionsProcess, Kratos::CheckSameModelPartUsingSkinDistanceProcess< TDim >, and Kratos::CalculateDistanceToPathProcess< THistorical >.

◆ Execute()

virtual void Kratos::Process::Execute ( )

inlinevirtual

Execute method is used to execute the Process algorithms.

◆ ExecuteAfterOutputStep()

virtual void Kratos::Process::ExecuteAfterOutputStep ( )

inlinevirtual

This function will be executed at every time step AFTER writing the output.

◆ ExecuteBeforeOutputStep()

virtual void Kratos::Process::ExecuteBeforeOutputStep ( )

inlinevirtual

This function will be executed at every time step BEFORE writing the output.

◆ ExecuteBeforeSolutionLoop()

virtual void Kratos::Process::ExecuteBeforeSolutionLoop ( )

inlinevirtual

This function is designed for being execute once before the solution loop but after all of the solvers where built.

◆ ExecuteFinalize()

virtual void Kratos::Process::ExecuteFinalize ( )

inlinevirtual

This function is designed for being called at the end of the computations.

◆ ExecuteFinalizeSolutionStep()

virtual void Kratos::Process::ExecuteFinalizeSolutionStep ( )

inlinevirtual

This function will be executed at every time step AFTER performing the solve phase.

◆ ExecuteInitialize()

virtual void Kratos::Process::ExecuteInitialize ( )

inlinevirtual

This function is designed for being called at the beginning of the computations right after reading the model and the groups.

◆ ExecuteInitializeSolutionStep()

virtual void Kratos::Process::ExecuteInitializeSolutionStep ( )

inlinevirtual

This function will be executed at every time step BEFORE performing the solve phase.

◆ GetDefaultParameters()

virtual const Parameters Kratos::Process::GetDefaultParameters ( ) const

inlinevirtual

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

◆ Info()

std::string Kratos::Process::Info ( ) const

inlineoverridevirtual

Turn back information as a string.

Reimplemented from Kratos::Flags.

◆ KRATOS_CLASS_POINTER_DEFINITION()

Kratos::Process::KRATOS_CLASS_POINTER_DEFINITION ( Process )

Pointer definition of Process.

◆ operator()()

void Kratos::Process::operator() ( )

inline

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

◆ PrintData()

void Kratos::Process::PrintData ( std::ostream & rOStream ) const

inlineoverridevirtual

Print object's data.

Reimplemented from Kratos::Flags.

◆ PrintInfo()

void Kratos::Process::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 file:

/home/runner/work/Documentation/Documentation/master/kratos/processes/process.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Process() [1/2]

◆ Process() [2/2]

◆ ~Process()

Member Function Documentation

◆ Check()

◆ Clear()

◆ Create()

◆ Execute()

◆ ExecuteAfterOutputStep()

◆ ExecuteBeforeOutputStep()

◆ ExecuteBeforeSolutionLoop()

◆ ExecuteFinalize()

◆ ExecuteFinalizeSolutionStep()

◆ ExecuteInitialize()

◆ ExecuteInitializeSolutionStep()

◆ GetDefaultParameters()

◆ Info()

◆ KRATOS_CLASS_POINTER_DEFINITION()

◆ operator()()

◆ PrintData()

◆ PrintInfo()