Kratos::Operation Class Reference

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

#include <operation.h>

Inheritance diagram for Kratos::Operation:

Collaboration diagram for Kratos::Operation:

Public Member Functions
Type Definitions
	KRATOS_CLASS_POINTER_DEFINITION (Operation)
	Pointer definition of Operation. More...
Life Cycle
	Operation ()=default
	Default constructor. More...
virtual	~Operation ()
	Destructor. More...
	Operation (Operation const &rOther)
	Copy constructor. More...
Operators
Operation &	operator= (Operation const &rOther)=delete
	Assignment operator. More...
void	operator() ()
	This operator is provided to call the process as a function and simply calls the Execute method. More...
Operations
virtual Operation::Pointer	Create (Model &rModel, Parameters ThisParameters) const
	This method creates an pointer of the process. More...
virtual void	Execute ()
	Execute method is used to execute the Operation algorithms. More...
virtual const Parameters	GetDefaultParameters () const
	This method provides the defaults parameters to avoid conflicts between the different constructors. More...
Input and output
std::string	Info () const
	Turn back information as a string. More...
void	PrintInfo (std::ostream &rOStream) const
	Print information about this object. More...
void	PrintData (std::ostream &rOStream) const
	Print object's data. More...

Detailed Description

The base class for all operations in Kratos.

The operation is the base class for all operations and defines the interface for them. Execute method is used to execute all the Operation algorithms. Operation parameters must be passed at construction time.

Author

Carlos Roig

Ruben Zorrilla

Constructor & Destructor Documentation

Operation() [1/2]

Kratos::Operation::Operation ( )

explicitdefault

Default constructor.

~Operation()

virtual Kratos::Operation::~Operation ( )

inlinevirtual

Destructor.

Operation() [2/2]

Kratos::Operation::Operation ( Operation const &  rOther )

inline

Copy constructor.

Member Function Documentation

Create()

virtual Operation::Pointer Kratos::Operation::Create ( Model &  rModel, Parameters  ThisParameters  ) const

inlinevirtual

This method creates an pointer of the process.

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

Warning

Must be overrided in each process implementation

Parameters

rModel	The model to be consider
ThisParameters	The configuration parameters

Reimplemented in Kratos::DeactivateModelPartOperation, Kratos::ActivateModelPartOperation, and Kratos::PotentialToCompressibleNavierStokesOperation.

Execute()

virtual void Kratos::Operation::Execute ( )

inlinevirtual

Execute method is used to execute the Operation algorithms.

Reimplemented in Kratos::DeactivateModelPartOperation, Kratos::ActivateModelPartOperation, and Kratos::PotentialToCompressibleNavierStokesOperation.

GetDefaultParameters()

virtual const Parameters Kratos::Operation::GetDefaultParameters ( ) const

inlinevirtual

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

Reimplemented in Kratos::PotentialToCompressibleNavierStokesOperation.

Info()

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

inline

Turn back information as a string.

KRATOS_CLASS_POINTER_DEFINITION()

Kratos::Operation::KRATOS_CLASS_POINTER_DEFINITION

(

Operation

)

Pointer definition of Operation.

operator()()

void Kratos::Operation::operator() ( )

inline

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

operator=()

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

delete

Assignment operator.

PrintData()

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

inline

Print object's data.

PrintInfo()

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

inline

Print information about this object.

---

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

• /home/runner/work/Documentation/Documentation/master/kratos/operations/operation.h