This process assigns a default value or a perturbation if the node is close to an influence area. More...

#include <apply_perturbation_function_process.h>

Inheritance diagram for Kratos::ApplyPerturbationFunctionProcess< TVarType >:

Collaboration diagram for Kratos::ApplyPerturbationFunctionProcess< TVarType >:

Public Member Functions
Life Cycle
	ApplyPerturbationFunctionProcess (ModelPart &rThisModelPart, NodePointerType pNode, TVarType &rThisVariable, Parameters &rThisParameters)
	Constructor with a node. More...

	ApplyPerturbationFunctionProcess (ModelPart &rThisModelPart, NodesArrayType &rSourcePoints, TVarType &rThisVariable, Parameters &rThisParameters)
	Constructor with an array of nodes. More...

	~ApplyPerturbationFunctionProcess () override
	Destructor. More...

Operators
void	operator() ()

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

int	Check () override
	Perform a check with the parameters. More...

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

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

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

virtual 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	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...

virtual const Parameters	GetDefaultParameters () const
	This method provides the defaults parameters to avoid conflicts between the different constructors. 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

typedef Node	NodeType

typedef Node::Pointer	NodePointerType

typedef ModelPart::NodesContainerType	NodesArrayType

typedef NodesArrayType::iterator	NodeIteratorType

	KRATOS_CLASS_POINTER_DEFINITION (ApplyPerturbationFunctionProcess)
	Pointer definition of ApplyPerturbationFunctionProcess. 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<class TVarType>
class Kratos::ApplyPerturbationFunctionProcess< TVarType >

This process assigns a default value or a perturbation if the node is close to an influence area.

Member Typedef Documentation

◆ IndexType

template<class TVarType >

typedef std::size_t Kratos::ApplyPerturbationFunctionProcess< TVarType >::IndexType

◆ NodeIteratorType

template<class TVarType >

typedef NodesArrayType::iterator Kratos::ApplyPerturbationFunctionProcess< TVarType >::NodeIteratorType

◆ NodePointerType

template<class TVarType >

typedef Node::Pointer Kratos::ApplyPerturbationFunctionProcess< TVarType >::NodePointerType

◆ NodesArrayType

template<class TVarType >

typedef ModelPart::NodesContainerType Kratos::ApplyPerturbationFunctionProcess< TVarType >::NodesArrayType

◆ NodeType

template<class TVarType >

typedef Node Kratos::ApplyPerturbationFunctionProcess< TVarType >::NodeType

Constructor & Destructor Documentation

◆ ApplyPerturbationFunctionProcess() [1/2]

template<class TVarType >

Kratos::ApplyPerturbationFunctionProcess< TVarType >::ApplyPerturbationFunctionProcess	(	ModelPart &	rThisModelPart,
		NodePointerType	pNode,
		TVarType &	rThisVariable,
		Parameters &	rThisParameters
	)

Constructor with a node.

◆ ApplyPerturbationFunctionProcess() [2/2]

template<class TVarType >

Kratos::ApplyPerturbationFunctionProcess< TVarType >::ApplyPerturbationFunctionProcess	(	ModelPart &	rThisModelPart,
		NodesArrayType &	rSourcePoints,
		TVarType &	rThisVariable,
		Parameters &	rThisParameters
	)

Constructor with an array of nodes.

◆ ~ApplyPerturbationFunctionProcess()

template<class TVarType >

Kratos::ApplyPerturbationFunctionProcess< TVarType >::~ApplyPerturbationFunctionProcess ( )

inlineoverride

Destructor.

Member Function Documentation

◆ Check()

template<class TVarType >

int Kratos::ApplyPerturbationFunctionProcess< TVarType >::Check

overridevirtual

Perform a check with the parameters.

Reimplemented from Kratos::Process.

◆ Execute()

template<class TVarType >

void Kratos::ApplyPerturbationFunctionProcess< TVarType >::Execute

overridevirtual

Execute method is used to execute the Process algorithms.

Reimplemented from Kratos::Process.

◆ ExecuteBeforeSolutionLoop()

template<class TVarType >

void Kratos::ApplyPerturbationFunctionProcess< TVarType >::ExecuteBeforeSolutionLoop

overridevirtual

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

Reimplemented from Kratos::Process.

◆ Info()

template<class TVarType >

virtual std::string Kratos::ApplyPerturbationFunctionProcess< TVarType >::Info ( ) const

inlineoverridevirtual

Turn back information as a string.

Reimplemented from Kratos::Process.

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<class TVarType >

Kratos::ApplyPerturbationFunctionProcess< TVarType >::KRATOS_CLASS_POINTER_DEFINITION ( ApplyPerturbationFunctionProcess< TVarType > )

Pointer definition of ApplyPerturbationFunctionProcess.

◆ operator()()

template<class TVarType >

void Kratos::ApplyPerturbationFunctionProcess< TVarType >::operator() ( )

inline

◆ PrintData()

template<class TVarType >

virtual void Kratos::ApplyPerturbationFunctionProcess< TVarType >::PrintData ( std::ostream & rOStream ) const

inlineoverridevirtual

Print object's data.

Reimplemented from Kratos::Process.

◆ PrintInfo()

template<class TVarType >

virtual void Kratos::ApplyPerturbationFunctionProcess< TVarType >::PrintInfo ( std::ostream & rOStream ) const

inlineoverridevirtual

Print information about this object.

Reimplemented from Kratos::Process.

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

/home/runner/work/Documentation/Documentation/master/applications/ShallowWaterApplication/custom_processes/apply_perturbation_function_process.h
/home/runner/work/Documentation/Documentation/master/applications/ShallowWaterApplication/custom_processes/apply_perturbation_function_process.cpp

Public Member Functions

Type Definitions

Additional Inherited Members

Detailed Description

template<class TVarType> class Kratos::ApplyPerturbationFunctionProcess< TVarType >

Member Typedef Documentation

◆ IndexType

◆ NodeIteratorType

◆ NodePointerType

◆ NodesArrayType

◆ NodeType

Constructor & Destructor Documentation

◆ ApplyPerturbationFunctionProcess() [1/2]

◆ ApplyPerturbationFunctionProcess() [2/2]

◆ ~ApplyPerturbationFunctionProcess()

Member Function Documentation

◆ Check()

◆ Execute()

◆ ExecuteBeforeSolutionLoop()

◆ Info()

◆ KRATOS_CLASS_POINTER_DEFINITION()

◆ operator()()

◆ PrintData()

◆ PrintInfo()

template<class TVarType>
class Kratos::ApplyPerturbationFunctionProcess< TVarType >