ProcessInfo holds the current value of different solution parameters. More...

#include <process_info.h>

Inheritance diagram for Kratos::ProcessInfo:

Collaboration diagram for Kratos::ProcessInfo:

Public Member Functions
Life Cycle
	ProcessInfo ()
	Default constructor. More...

	ProcessInfo (const ProcessInfo &Other)
	Copy constructor. More...

	~ProcessInfo () override
	Destructor. More...

Operators
ProcessInfo &	operator= (const ProcessInfo &rOther)
	Assignment operator. More...

Time steps
void	CreateTimeStepInfo (IndexType SolutionStepIndex=0)

void	CloneTimeStepInfo (IndexType SolutionStepIndex=0)

void	CloneTimeStepInfo (IndexType SolutionStepIndex, ProcessInfo const &SourceSolutionStepInfo)

void	CreateTimeStepInfo (double NewTime, IndexType SolutionStepIndex=0)

void	CloneTimeStepInfo (double NewTime, IndexType SourceSolutionStepIndex=0)

void	CloneTimeStepInfo (double NewTime, IndexType SolutionStepIndex, ProcessInfo const &SourceSolutionStepInfo)

void	SetAsTimeStepInfo ()

void	SetAsTimeStepInfo (double NewTime)

ProcessInfo::Pointer	pGetPreviousTimeStepInfo (IndexType StepsBefore=1)

const ProcessInfo::Pointer	pGetPreviousTimeStepInfo (IndexType StepsBefore=1) const

ProcessInfo &	GetPreviousTimeStepInfo (IndexType StepsBefore=1)

ProcessInfo const &	GetPreviousTimeStepInfo (IndexType StepsBefore=1) const

IndexType	GetPreviousTimeStepIndex (IndexType StepsBefore=1) const

Operations
void	SetCurrentTime (double NewTime)

void	ReIndexBuffer (SizeType BufferSize, IndexType BaseIndex=0)

Solution Step Data
void	CreateSolutionStepInfo (IndexType SolutionStepIndex=0)

void	CloneSolutionStepInfo ()

void	CloneSolutionStepInfo (IndexType SourceSolutionStepIndex)

void	CloneSolutionStepInfo (IndexType SolutionStepIndex, ProcessInfo const &SourceSolutionStepInfo)

ProcessInfo &	FindSolutionStepInfo (IndexType ThisIndex)

void	RemoveSolutionStepInfo (IndexType SolutionStepIndex)

void	ClearHistory (IndexType StepsBefore=0)

ProcessInfo::Pointer	pGetPreviousSolutionStepInfo (IndexType StepsBefore=1)

const ProcessInfo::Pointer	pGetPreviousSolutionStepInfo (IndexType StepsBefore=1) const

ProcessInfo &	GetPreviousSolutionStepInfo (IndexType StepsBefore=1)

ProcessInfo const &	GetPreviousSolutionStepInfo (IndexType StepsBefore=1) const

IndexType	GetPreviousSolutionStepIndex (IndexType StepsBefore=1) const

Access
IndexType	GetSolutionStepIndex () const

void	SetSolutionStepIndex (IndexType NewIndex)

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::DataValueContainer
	DataValueContainer ()
	Default constructor. More...

	DataValueContainer (DataValueContainer const &rOther)
	Copy constructor. More...

virtual	~DataValueContainer ()
	Destructor. More...

template<class TDataType >
const TDataType &	operator() (const VariableData &rThisVariable) const
	Accessor operator for retrieving a data value by a VariableData. More...

template<class TDataType >
TDataType &	operator() (const Variable< TDataType > &rThisVariable)
	Accessor operator for retrieving a data value by a Variable. More...

template<class TDataType >
const TDataType &	operator() (const Variable< TDataType > &rThisVariable) const
	Accessor operator for retrieving a data value by a Variable (const version). More...

template<class TDataType >
TDataType &	operator[] (const VariableData &rThisVariable)
	Index operator for retrieving a data value by a VariableData. More...

template<class TDataType >
const TDataType &	operator[] (const VariableData &rThisVariable) const
	Index operator for retrieving a data value by a VariableData (const version). More...

template<class TDataType >
TDataType &	operator[] (const Variable< TDataType > &rThisVariable)
	Index operator for retrieving a data value by a Variable. More...

template<class TDataType >
const TDataType &	operator[] (const Variable< TDataType > &rThisVariable) const
	Index operator for retrieving a data value by a Variable (const version). More...

iterator	begin ()
	Iterator pointing to the beginning of the container. More...

const_iterator	begin () const
	Const iterator pointing to the beginning of the container. More...

iterator	end ()
	Iterator pointing to the end of the container. More...

const_iterator	end () const
	Const iterator pointing to the end of the container. More...

DataValueContainer &	operator= (const DataValueContainer &rOther)
	Assignment operator for copying data from another DataValueContainer. More...

template<class TDataType >
TDataType &	GetValue (const Variable< TDataType > &rThisVariable)
	Gets the value associated with a given variable. More...

template<class TDataType >
const TDataType &	GetValue (const Variable< TDataType > &rThisVariable) const
	Gets the value associated with a given variable (const version). More...

SizeType	Size ()
	Gets the size of the data container. More...

template<class TDataType >
void	SetValue (const Variable< TDataType > &rThisVariable, TDataType const &rValue)
	Sets the value for a given variable. More...

template<class TDataType >
void	Erase (const Variable< TDataType > &rThisVariable)
	Erases the value associated with a given variable. More...

void	Clear ()
	Clears the entire data container. More...

void	Merge (const DataValueContainer &rOther, const Flags Options)
	Merges this data container with another data container. More...

template<class TDataType >
bool	Has (const Variable< TDataType > &rThisVariable) const
	Checks if the data container has a value associated with a given variable. More...

bool	IsEmpty () const
	Checks if the data container is empty. More...

	KRATOS_DEFINE_LOCAL_FLAG (OVERWRITE_OLD_VALUES)
	Define local flag. More...

	KRATOS_CLASS_POINTER_DEFINITION (DataValueContainer)
	Pointer definition of DataValueContainer. 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 DataValueContainer	BaseType

typedef std::size_t	SizeType

typedef std::size_t	IndexType

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

Serialization
class	Serializer

Additional Inherited Members
Public Types inherited from Kratos::DataValueContainer
using	ValueType = std::pair< const VariableData , void >
	Type of the container used for variables. More...

using	ContainerType = std::vector< ValueType >
	Type of the container used for variables. More...

using	iterator = ContainerType::iterator
	Type of the container used for variables. More...

using	const_iterator = ContainerType::const_iterator
	Type of the container used for variables. More...

using	SizeType = ContainerType::size_type
	Type of the container used for variables. 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

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

ProcessInfo holds the current value of different solution parameters.

ProcessInfo holds the current value of different solution parameters. It can be used to keep variables like time, solution step, non linear step, or any other variable defined in Kratos. Its variable base interface provides a clear and flexible access to these data.

Member Typedef Documentation

◆ BaseType

typedef DataValueContainer Kratos::ProcessInfo::BaseType

◆ IndexType

typedef std::size_t Kratos::ProcessInfo::IndexType

◆ SizeType

typedef std::size_t Kratos::ProcessInfo::SizeType

Constructor & Destructor Documentation

◆ ProcessInfo() [1/2]

Kratos::ProcessInfo::ProcessInfo ( )

inline

Default constructor.

◆ ProcessInfo() [2/2]

Kratos::ProcessInfo::ProcessInfo ( const ProcessInfo & Other )

inline

Copy constructor.

◆ ~ProcessInfo()

Kratos::ProcessInfo::~ProcessInfo ( )

inlineoverride

Destructor.

Member Function Documentation

◆ ClearHistory()

void Kratos::ProcessInfo::ClearHistory ( IndexType StepsBefore = 0 )

◆ CloneSolutionStepInfo() [1/3]

void Kratos::ProcessInfo::CloneSolutionStepInfo ( )

◆ CloneSolutionStepInfo() [2/3]

void Kratos::ProcessInfo::CloneSolutionStepInfo	(	IndexType	SolutionStepIndex,
		ProcessInfo const &	SourceSolutionStepInfo
	)

◆ CloneSolutionStepInfo() [3/3]

void Kratos::ProcessInfo::CloneSolutionStepInfo ( IndexType SourceSolutionStepIndex )

◆ CloneTimeStepInfo() [1/4]

void Kratos::ProcessInfo::CloneTimeStepInfo	(	double	NewTime,
		IndexType	SolutionStepIndex,
		ProcessInfo const &	SourceSolutionStepInfo
	)

inline

◆ CloneTimeStepInfo() [2/4]

void Kratos::ProcessInfo::CloneTimeStepInfo	(	double	NewTime,
		IndexType	SourceSolutionStepIndex = `0`
	)

inline

◆ CloneTimeStepInfo() [3/4]

void Kratos::ProcessInfo::CloneTimeStepInfo	(	IndexType	SolutionStepIndex,
		ProcessInfo const &	SourceSolutionStepInfo
	)

inline

◆ CloneTimeStepInfo() [4/4]

void Kratos::ProcessInfo::CloneTimeStepInfo ( IndexType SolutionStepIndex = 0 )

inline

◆ CreateSolutionStepInfo()

void Kratos::ProcessInfo::CreateSolutionStepInfo ( IndexType SolutionStepIndex = 0 )

◆ CreateTimeStepInfo() [1/2]

void Kratos::ProcessInfo::CreateTimeStepInfo	(	double	NewTime,
		IndexType	SolutionStepIndex = `0`
	)

inline

◆ CreateTimeStepInfo() [2/2]

void Kratos::ProcessInfo::CreateTimeStepInfo ( IndexType SolutionStepIndex = 0 )

inline

◆ FindSolutionStepInfo()

ProcessInfo & Kratos::ProcessInfo::FindSolutionStepInfo ( IndexType ThisIndex )

◆ GetPreviousSolutionStepIndex()

IndexType Kratos::ProcessInfo::GetPreviousSolutionStepIndex ( IndexType StepsBefore = 1 ) const

inline

◆ GetPreviousSolutionStepInfo() [1/2]

ProcessInfo& Kratos::ProcessInfo::GetPreviousSolutionStepInfo ( IndexType StepsBefore = 1 )

inline

◆ GetPreviousSolutionStepInfo() [2/2]

ProcessInfo const& Kratos::ProcessInfo::GetPreviousSolutionStepInfo ( IndexType StepsBefore = 1 ) const

inline

◆ GetPreviousTimeStepIndex()

IndexType Kratos::ProcessInfo::GetPreviousTimeStepIndex ( IndexType StepsBefore = 1 ) const

inline

◆ GetPreviousTimeStepInfo() [1/2]

ProcessInfo& Kratos::ProcessInfo::GetPreviousTimeStepInfo ( IndexType StepsBefore = 1 )

inline

◆ GetPreviousTimeStepInfo() [2/2]

ProcessInfo const& Kratos::ProcessInfo::GetPreviousTimeStepInfo ( IndexType StepsBefore = 1 ) const

inline

◆ GetSolutionStepIndex()

IndexType Kratos::ProcessInfo::GetSolutionStepIndex ( ) const

inline

◆ Info()

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

inlineoverridevirtual

Turn back information as a string.

Reimplemented from Kratos::DataValueContainer.

◆ KRATOS_CLASS_POINTER_DEFINITION()

Kratos::ProcessInfo::KRATOS_CLASS_POINTER_DEFINITION ( ProcessInfo )

Pointer definition of ProcessInfo.

◆ operator=()

ProcessInfo& Kratos::ProcessInfo::operator= ( const ProcessInfo & rOther )

inline

Assignment operator.

◆ pGetPreviousSolutionStepInfo() [1/2]

ProcessInfo::Pointer Kratos::ProcessInfo::pGetPreviousSolutionStepInfo ( IndexType StepsBefore = 1 )

◆ pGetPreviousSolutionStepInfo() [2/2]

const ProcessInfo::Pointer Kratos::ProcessInfo::pGetPreviousSolutionStepInfo ( IndexType StepsBefore = 1 ) const

◆ pGetPreviousTimeStepInfo() [1/2]

ProcessInfo::Pointer Kratos::ProcessInfo::pGetPreviousTimeStepInfo ( IndexType StepsBefore = 1 )

◆ pGetPreviousTimeStepInfo() [2/2]

const ProcessInfo::Pointer Kratos::ProcessInfo::pGetPreviousTimeStepInfo ( IndexType StepsBefore = 1 ) const

◆ PrintData()

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

inlineoverridevirtual

Print object's data.

Reimplemented from Kratos::DataValueContainer.

◆ PrintInfo()

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

inlineoverridevirtual

Print information about this object.

Reimplemented from Kratos::DataValueContainer.

◆ ReIndexBuffer()

void Kratos::ProcessInfo::ReIndexBuffer	(	SizeType	BufferSize,
		IndexType	BaseIndex = `0`
	)

◆ RemoveSolutionStepInfo()

void Kratos::ProcessInfo::RemoveSolutionStepInfo ( IndexType SolutionStepIndex )

◆ SetAsTimeStepInfo() [1/2]

void Kratos::ProcessInfo::SetAsTimeStepInfo ( )

◆ SetAsTimeStepInfo() [2/2]

void Kratos::ProcessInfo::SetAsTimeStepInfo ( double NewTime )

◆ SetCurrentTime()

void Kratos::ProcessInfo::SetCurrentTime ( double NewTime )

◆ SetSolutionStepIndex()

void Kratos::ProcessInfo::SetSolutionStepIndex ( IndexType NewIndex )

inline

Friends And Related Function Documentation

◆ Serializer

friend class Serializer

friend

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

/home/runner/work/Documentation/Documentation/master/kratos/includes/process_info.h
/home/runner/work/Documentation/Documentation/master/kratos/sources/process_info.cpp

Public Member Functions

Type Definitions

Serialization

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseType

◆ IndexType

◆ SizeType

Constructor & Destructor Documentation

◆ ProcessInfo() [1/2]

◆ ProcessInfo() [2/2]

◆ ~ProcessInfo()

Member Function Documentation

◆ ClearHistory()

◆ CloneSolutionStepInfo() [1/3]

◆ CloneSolutionStepInfo() [2/3]

◆ CloneSolutionStepInfo() [3/3]

◆ CloneTimeStepInfo() [1/4]

◆ CloneTimeStepInfo() [2/4]

◆ CloneTimeStepInfo() [3/4]

◆ CloneTimeStepInfo() [4/4]

◆ CreateSolutionStepInfo()

◆ CreateTimeStepInfo() [1/2]

◆ CreateTimeStepInfo() [2/2]

◆ FindSolutionStepInfo()

◆ GetPreviousSolutionStepIndex()

◆ GetPreviousSolutionStepInfo() [1/2]

◆ GetPreviousSolutionStepInfo() [2/2]

◆ GetPreviousTimeStepIndex()

◆ GetPreviousTimeStepInfo() [1/2]

◆ GetPreviousTimeStepInfo() [2/2]

◆ GetSolutionStepIndex()

◆ Info()

◆ KRATOS_CLASS_POINTER_DEFINITION()

◆ operator=()

◆ pGetPreviousSolutionStepInfo() [1/2]

◆ pGetPreviousSolutionStepInfo() [2/2]

◆ pGetPreviousTimeStepInfo() [1/2]

◆ pGetPreviousTimeStepInfo() [2/2]

◆ PrintData()

◆ PrintInfo()

◆ ReIndexBuffer()

◆ RemoveSolutionStepInfo()

◆ SetAsTimeStepInfo() [1/2]

◆ SetAsTimeStepInfo() [2/2]

◆ SetCurrentTime()

◆ SetSolutionStepIndex()

Friends And Related Function Documentation

◆ Serializer