Kratos::OutputController Class Reference

#include <output_controller.h>

Inheritance diagram for Kratos::OutputController:

Collaboration diagram for Kratos::OutputController:

Public Member Functions
Type Definitions
	KRATOS_CLASS_POINTER_DEFINITION (OutputController)
	Pointer definition of OutputController. More...
Life Cycle
	OutputController (const Model &rModel, Parameters Settings)
	Default constructor. More...
	~OutputController () override=default
	Destructor. More...
	OutputController (OutputController const &rOther)=default
	Copy constructor. More...
	OutputController (OutputController &&rOther) noexcept=default
	Move constructor. More...
Operators
OutputController &	operator= (OutputController const &rOther)=delete
	Assignment operator. More...
Operations
Controller::Pointer	Create (Model &rModel, Parameters Settings) const override
	This method creates an pointer of the controller. More...
int	Check () const override
	Checks that input conditions are correct. More...
bool	Evaluate () const override
	Using input data, returns bool. More...
void	Update () override
	Update the controller parameters. More...
std::variant< int, double >	GetCurrentControlValue () const
	Returns the current control value used to evalute. More...
std::variant< int, double >	GetInterval () const
	Get the interval used in the control. More...
std::variant< int, double >	GetNextPossibleEvaluateControlValue () const
	Get the next possible evaluation control value. More...
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::Controller
	KRATOS_CLASS_POINTER_DEFINITION (Controller)
	Pointer definition of Controller. More...
	Controller () noexcept=default
	Default constructor. More...
virtual	~Controller ()=default
	Destructor. More...
	Controller (Controller const &rOther)=default
	Copy constructor. More...
	Controller (Controller &&rOther) noexcept=default
	Move constructor. More...
Controller &	operator= (Controller const &rOther)=delete
	Assignment operator. More...

Constructor & Destructor Documentation

OutputController() [1/3]

Kratos::OutputController::OutputController	(	const Model &	rModel,
		Parameters	Settings
	)

Default constructor.

~OutputController()

Kratos::OutputController::~OutputController ( )

overridedefault

Destructor.

OutputController() [2/3]

Kratos::OutputController::OutputController ( OutputController const &  rOther )

default

Copy constructor.

OutputController() [3/3]

Kratos::OutputController::OutputController ( OutputController &&  rOther )

defaultnoexcept

Move constructor.

Member Function Documentation

Check()

int Kratos::OutputController::Check ( ) const

overridevirtual

Checks that input conditions are correct.

Reimplemented from Kratos::Controller.

Create()

Controller::Pointer Kratos::OutputController::Create ( Model &  rModel, Parameters  Settings  ) const

overridevirtual

This method creates an pointer of the controller.

We consider as input, a Model and a set of Parameters for the sake of generality

Warning

Must be overrided in controller implementation

Parameters

rModel	The model to be considered
ThisParameters	The configuration parameters

Implements Kratos::Controller.

Evaluate()

bool Kratos::OutputController::Evaluate ( ) const

overridevirtual

Using input data, returns bool.

Implements Kratos::Controller.

GetCurrentControlValue()

std::variant< int, double > Kratos::OutputController::GetCurrentControlValue

(

)

const

Returns the current control value used to evalute.

GetDefaultParameters()

Parameters Kratos::OutputController::GetDefaultParameters ( ) const

overridevirtual

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

Reimplemented from Kratos::Controller.

GetInterval()

std::variant< int, double > Kratos::OutputController::GetInterval

(

)

const

Get the interval used in the control.

GetNextPossibleEvaluateControlValue()

std::variant< int, double > Kratos::OutputController::GetNextPossibleEvaluateControlValue

(

)

const

Get the next possible evaluation control value.

Info()

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

overridevirtual

Turn back information as a string.

Reimplemented from Kratos::Controller.

KRATOS_CLASS_POINTER_DEFINITION()

Kratos::OutputController::KRATOS_CLASS_POINTER_DEFINITION

(

OutputController

)

Pointer definition of OutputController.

operator=()

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

delete

Assignment operator.

PrintData()

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

overridevirtual

Print object's data.

Reimplemented from Kratos::Controller.

PrintInfo()

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

overridevirtual

Print information about this object.

Reimplemented from Kratos::Controller.

Update()

void Kratos::OutputController::Update ( )

overridevirtual

Update the controller parameters.

Reimplemented from Kratos::Controller.

---

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

• /home/runner/work/Documentation/Documentation/master/kratos/controllers/output_controller.h
• /home/runner/work/Documentation/Documentation/master/kratos/controllers/output_controller.cpp