Line output process. More...

#include <rans_line_output_process.h>

Inheritance diagram for Kratos::RansLineOutputProcess:

Collaboration diagram for Kratos::RansLineOutputProcess:

Public Member Functions
Life Cycle
	RansLineOutputProcess (Model &rModel, Parameters rParameters)
	Constructor. More...

	~RansLineOutputProcess () override=default
	Destructor. More...

RansLineOutputProcess &	operator= (RansLineOutputProcess const &rOther)=delete
	Assignment operator. More...

	RansLineOutputProcess (RansLineOutputProcess const &rOther)=delete
	Copy constructor. More...

Operations
int	Check () override
	This function is designed for being called after ExecuteInitialize ONCE to verify that the input is correct. More...

void	ExecuteInitialize () override
	This function is designed for being called at the beginning of the computations right after reading the model and the groups. More...

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

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	ExecuteBeforeSolutionLoop ()
	This function is designed for being execute once before the solution loop but after all of the solvers where built. 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...

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
using	NodeType = ModelPart::NodeType

using	SizeType = std::size_t

using	IndicesVector = std::vector< int >

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

Line output process.

This process outputs double/array_1d<double, 3> variables in historical/non-historical nodal data value containers to files. Values will be sampled along a lint from starting point to end point with given number of sampling points. All the sampled values will be written into one file per time step.

Output frequency can be controlled by output control parameters. But, if a string is used as output control variable, then it is assumed every step is output step.

Output is given in Comma Seperated Values (CSV) format.

Member Typedef Documentation

◆ IndicesVector

using Kratos::RansLineOutputProcess::IndicesVector = std::vector<int>

◆ NodeType

using Kratos::RansLineOutputProcess::NodeType = ModelPart::NodeType

◆ SizeType

using Kratos::RansLineOutputProcess::SizeType = std::size_t

Constructor & Destructor Documentation

◆ RansLineOutputProcess() [1/2]

Kratos::RansLineOutputProcess::RansLineOutputProcess	(	Model &	rModel,
		Parameters	rParameters
	)

Constructor.

◆ ~RansLineOutputProcess()

Kratos::RansLineOutputProcess::~RansLineOutputProcess ( )

overridedefault

Destructor.

◆ RansLineOutputProcess() [2/2]

Kratos::RansLineOutputProcess::RansLineOutputProcess ( RansLineOutputProcess const & rOther )

delete

Copy constructor.

Member Function Documentation

◆ Check()

int Kratos::RansLineOutputProcess::Check ( )

overridevirtual

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

Reimplemented from Kratos::Process.

◆ ExecuteFinalizeSolutionStep()

void Kratos::RansLineOutputProcess::ExecuteFinalizeSolutionStep ( )

overridevirtual

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

Reimplemented from Kratos::Process.

◆ ExecuteInitialize()

void Kratos::RansLineOutputProcess::ExecuteInitialize ( )

overridevirtual

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::RansLineOutputProcess::ExecuteInitializeSolutionStep ( )

overridevirtual

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

Reimplemented from Kratos::Process.

◆ GetDefaultParameters()

const Parameters Kratos::RansLineOutputProcess::GetDefaultParameters ( ) const

overridevirtual

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

Reimplemented from Kratos::Process.

◆ Info()

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

overridevirtual

Turn back information as a string.

Reimplemented from Kratos::Process.

◆ KRATOS_CLASS_POINTER_DEFINITION()

Kratos::RansLineOutputProcess::KRATOS_CLASS_POINTER_DEFINITION ( RansLineOutputProcess )

Pointer definition of RansLineOutputProcess.

◆ operator=()

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

delete

Assignment operator.

◆ PrintData()

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

overridevirtual

Print object's data.

Reimplemented from Kratos::Process.

◆ PrintInfo()

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

overridevirtual

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/RANSApplication/custom_processes/rans_line_output_process.h
/home/runner/work/Documentation/Documentation/master/applications/RANSApplication/custom_processes/rans_line_output_process.cpp

Public Member Functions

Type Definitions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ IndicesVector

◆ NodeType

◆ SizeType

Constructor & Destructor Documentation

◆ RansLineOutputProcess() [1/2]

◆ ~RansLineOutputProcess()

◆ RansLineOutputProcess() [2/2]

Member Function Documentation

◆ Check()

◆ ExecuteFinalizeSolutionStep()

◆ ExecuteInitialize()

◆ ExecuteInitializeSolutionStep()

◆ GetDefaultParameters()

◆ Info()

◆ KRATOS_CLASS_POINTER_DEFINITION()

◆ operator=()

◆ PrintData()

◆ PrintInfo()