This function assigns a value from an input to a variable belonging to all of the entities in a given mesh. More...

#include <assign_scalar_input_to_entities_process.h>

Inheritance diagram for Kratos::AssignScalarInputToEntitiesProcess< TEntity, THistorical >:

Collaboration diagram for Kratos::AssignScalarInputToEntitiesProcess< TEntity, THistorical >:

Public Types
Enum's
enum class	Algorithm { NEAREST_NEIGHBOUR = 0 }
	This enum helps us to identify the algorithm considered. More...

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

Public Member Functions
Life Cycle
	AssignScalarInputToEntitiesProcess (ModelPart &rModelPart, Parameters rParameters)
	Default constructor. More...

	~AssignScalarInputToEntitiesProcess () override
	Destructor. More...

Operations
void	ExecuteInitializeSolutionStep () override
	This function will be executed at every time step BEFORE performing the solve phase. 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 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	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 Node	NodeType
	Node type definition. More...

typedef std::size_t	IndexType
	The definition of the index type. More...

typedef std::size_t	SizeType
	The definition of the sizetype. More...

typedef PointerVectorSet< TEntity, IndexedObject >	EntityContainerType
	The container of the entities. More...

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

	KRATOS_DEFINE_LOCAL_FLAG (GEOMETRIC_DEFINITION)
	Local Flags. More...

Additional Inherited Members
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 TEntity, bool THistorical = false>
class Kratos::AssignScalarInputToEntitiesProcess< TEntity, THistorical >

This function assigns a value from an input to a variable belonging to all of the entities in a given mesh.

Can be used to any entities

Template Parameters

TEntity The entity type

Author: Vicente Mataix Ferrandiz

Member Typedef Documentation

◆ EntityContainerType

template<class TEntity , bool THistorical = false>

typedef PointerVectorSet<TEntity, IndexedObject> Kratos::AssignScalarInputToEntitiesProcess< TEntity, THistorical >::EntityContainerType

The container of the entities.

◆ IndexType

template<class TEntity , bool THistorical = false>

typedef std::size_t Kratos::AssignScalarInputToEntitiesProcess< TEntity, THistorical >::IndexType

The definition of the index type.

◆ NodeType

template<class TEntity , bool THistorical = false>

typedef Node Kratos::AssignScalarInputToEntitiesProcess< TEntity, THistorical >::NodeType

Node type definition.

◆ SizeType

template<class TEntity , bool THistorical = false>

typedef std::size_t Kratos::AssignScalarInputToEntitiesProcess< TEntity, THistorical >::SizeType

The definition of the sizetype.

Member Enumeration Documentation

◆ Algorithm

template<class TEntity , bool THistorical = false>

enum Kratos::AssignScalarInputToEntitiesProcess::Algorithm

strong

This enum helps us to identify the algorithm considered.

Enumerator
NEAREST_NEIGHBOUR

Constructor & Destructor Documentation

◆ AssignScalarInputToEntitiesProcess()

template<class TEntity , bool THistorical>

Kratos::AssignScalarInputToEntitiesProcess< TEntity, THistorical >::AssignScalarInputToEntitiesProcess	(	ModelPart &	rModelPart,
		Parameters	rParameters
	)

Default constructor.

Parameters

rModelPart	The model part to be set
rParameters	The configuration parameters

◆ ~AssignScalarInputToEntitiesProcess()

template<class TEntity , bool THistorical = false>

Kratos::AssignScalarInputToEntitiesProcess< TEntity, THistorical >::~AssignScalarInputToEntitiesProcess ( )

inlineoverride

Destructor.

Member Function Documentation

◆ ExecuteInitializeSolutionStep()

template<class TEntity , bool THistorical>

void Kratos::AssignScalarInputToEntitiesProcess< TEntity, THistorical >::ExecuteInitializeSolutionStep

overridevirtual

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

Reimplemented from Kratos::Process.

◆ GetDefaultParameters()

template<class TEntity , bool THistorical>

const Parameters Kratos::AssignScalarInputToEntitiesProcess< TEntity, THistorical >::GetDefaultParameters

overridevirtual

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

Reimplemented from Kratos::Process.

◆ Info()

template<class TEntity , bool THistorical = false>

std::string Kratos::AssignScalarInputToEntitiesProcess< TEntity, THistorical >::Info ( ) const

inlineoverridevirtual

Turn back information as a string.

Reimplemented from Kratos::Flags.

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<class TEntity , bool THistorical = false>

Kratos::AssignScalarInputToEntitiesProcess< TEntity, THistorical >::KRATOS_CLASS_POINTER_DEFINITION ( AssignScalarInputToEntitiesProcess< TEntity, THistorical > )

Pointer definition of AssignScalarInputToEntitiesProcess.

◆ KRATOS_DEFINE_LOCAL_FLAG()

template<class TEntity , bool THistorical = false>

Kratos::AssignScalarInputToEntitiesProcess< TEntity, THistorical >::KRATOS_DEFINE_LOCAL_FLAG ( GEOMETRIC_DEFINITION )

Local Flags.

◆ PrintData()

template<class TEntity , bool THistorical = false>

void Kratos::AssignScalarInputToEntitiesProcess< TEntity, THistorical >::PrintData ( std::ostream & rOStream ) const

inlineoverridevirtual

Print object's data.

Reimplemented from Kratos::Flags.

◆ PrintInfo()

template<class TEntity , bool THistorical = false>

void Kratos::AssignScalarInputToEntitiesProcess< TEntity, 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/assign_scalar_input_to_entities_process.h
/home/runner/work/Documentation/Documentation/master/kratos/processes/assign_scalar_input_to_entities_process.cpp

Public Types

Public Member Functions

Type Definitions

Additional Inherited Members

Detailed Description

template<class TEntity, bool THistorical = false> class Kratos::AssignScalarInputToEntitiesProcess< TEntity, THistorical >

Member Typedef Documentation

◆ EntityContainerType

◆ IndexType

◆ NodeType

◆ SizeType

Member Enumeration Documentation

◆ Algorithm

Constructor & Destructor Documentation

◆ AssignScalarInputToEntitiesProcess()

◆ ~AssignScalarInputToEntitiesProcess()

Member Function Documentation

◆ ExecuteInitializeSolutionStep()

◆ GetDefaultParameters()

◆ Info()

◆ KRATOS_CLASS_POINTER_DEFINITION()

◆ KRATOS_DEFINE_LOCAL_FLAG()

◆ PrintData()

◆ PrintInfo()

template<class TEntity, bool THistorical = false>
class Kratos::AssignScalarInputToEntitiesProcess< TEntity, THistorical >