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

#include <apply_constant_scalarvalue_process.h>

Inheritance diagram for Kratos::ApplyConstantScalarValueProcess:

Collaboration diagram for Kratos::ApplyConstantScalarValueProcess:

Public Member Functions
Type Definitions
	KRATOS_DEFINE_LOCAL_FLAG (VARIABLE_IS_FIXED)

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

Life Cycle
	ApplyConstantScalarValueProcess (ModelPart &model_part, Parameters rParameters)

	ApplyConstantScalarValueProcess (ModelPart &model_part, const Variable< double > &rVariable, const double double_value, std::size_t mesh_id, const Flags options)

	ApplyConstantScalarValueProcess (ModelPart &model_part, const Variable< int > &rVariable, const int int_value, std::size_t mesh_id, const Flags options)

	ApplyConstantScalarValueProcess (ModelPart &model_part, const Variable< bool > &rVariable, const bool bool_value, std::size_t mesh_id, const Flags options)

	~ApplyConstantScalarValueProcess () override
	Destructor. More...

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

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

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

void	ExecuteInitialize () override

void	ExecuteBeforeSolutionLoop () override

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

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

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

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

void	ExecuteFinalize () override

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

Protected Attributes
ModelPart &	mr_model_part

std::string	mvariable_name

double	mdouble_value

int	mint_value

bool	mbool_value

std::size_t	mmesh_id

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.

This function applies a constant value (and fixity) to all of the nodes in a given mesh

Constructor & Destructor Documentation

◆ ApplyConstantScalarValueProcess() [1/4]

Kratos::ApplyConstantScalarValueProcess::ApplyConstantScalarValueProcess	(	ModelPart &	model_part,
		Parameters	rParameters
	)

inline

◆ ApplyConstantScalarValueProcess() [2/4]

Kratos::ApplyConstantScalarValueProcess::ApplyConstantScalarValueProcess	(	ModelPart &	model_part,
		const Variable< double > &	rVariable,
		const double	double_value,
		std::size_t	mesh_id,
		const Flags	options
	)

inline

◆ ApplyConstantScalarValueProcess() [3/4]

Kratos::ApplyConstantScalarValueProcess::ApplyConstantScalarValueProcess	(	ModelPart &	model_part,
		const Variable< int > &	rVariable,
		const int	int_value,
		std::size_t	mesh_id,
		const Flags	options
	)

inline

◆ ApplyConstantScalarValueProcess() [4/4]

Kratos::ApplyConstantScalarValueProcess::ApplyConstantScalarValueProcess	(	ModelPart &	model_part,
		const Variable< bool > &	rVariable,
		const bool	bool_value,
		std::size_t	mesh_id,
		const Flags	options
	)

inline

◆ ~ApplyConstantScalarValueProcess()

Kratos::ApplyConstantScalarValueProcess::~ApplyConstantScalarValueProcess ( )

inlineoverride

Destructor.

Member Function Documentation

◆ Execute()

void Kratos::ApplyConstantScalarValueProcess::Execute ( )

inlineoverridevirtual

Execute method is used to execute the ApplyConstantScalarValueProcess algorithms.

Reimplemented from Kratos::Process.

◆ ExecuteAfterOutputStep()

void Kratos::ApplyConstantScalarValueProcess::ExecuteAfterOutputStep ( )

inlineoverridevirtual

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

Reimplemented from Kratos::Process.

◆ ExecuteBeforeOutputStep()

void Kratos::ApplyConstantScalarValueProcess::ExecuteBeforeOutputStep ( )

inlineoverridevirtual

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

Reimplemented from Kratos::Process.

◆ ExecuteBeforeSolutionLoop()

void Kratos::ApplyConstantScalarValueProcess::ExecuteBeforeSolutionLoop ( )

inlineoverridevirtual

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

Reimplemented from Kratos::Process.

◆ ExecuteFinalize()

void Kratos::ApplyConstantScalarValueProcess::ExecuteFinalize ( )

inlineoverridevirtual

this function is designed for being called at the end of the computations right after reading the model and the groups

Reimplemented from Kratos::Process.

◆ ExecuteFinalizeSolutionStep()

void Kratos::ApplyConstantScalarValueProcess::ExecuteFinalizeSolutionStep ( )

inlineoverridevirtual

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

Reimplemented from Kratos::Process.

◆ ExecuteInitialize()

void Kratos::ApplyConstantScalarValueProcess::ExecuteInitialize ( )

inlineoverridevirtual

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

Reimplemented from Kratos::Process.

◆ ExecuteInitializeSolutionStep()

void Kratos::ApplyConstantScalarValueProcess::ExecuteInitializeSolutionStep ( )

inlineoverridevirtual

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

Reimplemented from Kratos::Process.

◆ GetDefaultParameters()

const Parameters Kratos::ApplyConstantScalarValueProcess::GetDefaultParameters ( ) const

inlineoverridevirtual

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

Reimplemented from Kratos::Process.

◆ Info()

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

inlineoverridevirtual

Turn back information as a string.

Reimplemented from Kratos::Flags.

◆ KRATOS_CLASS_POINTER_DEFINITION()

Kratos::ApplyConstantScalarValueProcess::KRATOS_CLASS_POINTER_DEFINITION ( ApplyConstantScalarValueProcess )

Pointer definition of ApplyConstantScalarValueProcess.

◆ KRATOS_DEFINE_LOCAL_FLAG()

Kratos::ApplyConstantScalarValueProcess::KRATOS_DEFINE_LOCAL_FLAG ( VARIABLE_IS_FIXED )

◆ operator()()

void Kratos::ApplyConstantScalarValueProcess::operator() ( )

inline

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

◆ PrintData()

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

inlineoverridevirtual

Print object's data.

Reimplemented from Kratos::Flags.

◆ PrintInfo()

void Kratos::ApplyConstantScalarValueProcess::PrintInfo ( std::ostream & rOStream ) const

inlineoverridevirtual

Print information about this object.

Reimplemented from Kratos::Flags.

Member Data Documentation

◆ mbool_value

bool Kratos::ApplyConstantScalarValueProcess::mbool_value

protected

◆ mdouble_value

double Kratos::ApplyConstantScalarValueProcess::mdouble_value

protected

◆ mint_value

int Kratos::ApplyConstantScalarValueProcess::mint_value

protected

◆ mmesh_id

std::size_t Kratos::ApplyConstantScalarValueProcess::mmesh_id

protected

◆ mr_model_part

ModelPart& Kratos::ApplyConstantScalarValueProcess::mr_model_part

protected

◆ mvariable_name

std::string Kratos::ApplyConstantScalarValueProcess::mvariable_name

protected

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ApplyConstantScalarValueProcess() [1/4]

◆ ApplyConstantScalarValueProcess() [2/4]

◆ ApplyConstantScalarValueProcess() [3/4]

◆ ApplyConstantScalarValueProcess() [4/4]

◆ ~ApplyConstantScalarValueProcess()

Member Function Documentation

◆ Execute()

◆ ExecuteAfterOutputStep()

◆ ExecuteBeforeOutputStep()

◆ ExecuteBeforeSolutionLoop()

◆ ExecuteFinalize()

◆ ExecuteFinalizeSolutionStep()

◆ ExecuteInitialize()

◆ ExecuteInitializeSolutionStep()

◆ GetDefaultParameters()

◆ Info()

◆ KRATOS_CLASS_POINTER_DEFINITION()

◆ KRATOS_DEFINE_LOCAL_FLAG()

◆ operator()()

◆ PrintData()

◆ PrintInfo()

Member Data Documentation

◆ mbool_value

◆ mdouble_value

◆ mint_value

◆ mmesh_id

◆ mr_model_part

◆ mvariable_name