Kratos::ProcessFactoryUtility Class Reference

This is a experimental process factory utility. More...

#include <process_factory_utility.h>

Collaboration diagram for Kratos::ProcessFactoryUtility:

Public Member Functions
Life Cycle
	ProcessFactoryUtility ()=default
	Default constructors. More...
	ProcessFactoryUtility (ListType &ProcessesList)
	Constructor using a list of processes. More...
	ProcessFactoryUtility (ObjectType &rProcess)
	Constructor using just one process. More...
virtual	~ProcessFactoryUtility ()=default
	Destructor. More...
Operators
ProcessFactoryUtility &	operator= (ProcessFactoryUtility const &rOther)=default
	Assignment operator. More...
Operations
void	AddProcess (ObjectType &rProcess)
	It add new process to the existing process list. More...
void	AddProcesses (ListType &ProcessesList)
	It add new processes to the existing process list. More...
void	ExecuteMethod (const std::string &rNameMethod)
	It executes the method considered in the input. More...
void	ExecuteInitialize ()
	It executes the ExecuteInitialize() from the list of processes. More...
void	ExecuteBeforeSolutionLoop ()
	It executes the ExecuteBeforeSolutionLoop() from the list of processes. More...
void	ExecuteInitializeSolutionStep ()
	It executes the ExecuteInitializeSolutionStep() from the list of processes. More...
void	ExecuteFinalizeSolutionStep ()
	It executes the ExecuteFinalizeSolutionStep() from the list of processes. More...
void	ExecuteBeforeOutputStep ()
	It executes the ExecuteBeforeOutputStep() from the list of processes. More...
void	ExecuteAfterOutputStep ()
	It executes the ExecuteAfterOutputStep() from the list of processes. More...
void	ExecuteFinalize ()
	It executes the ExecuteFinalize() from the list of processes. More...
void	IsOutputStep ()
	It executes the IsOutputStep() from the list of processes. More...
void	PrintOutput ()
	It executes the PrintOutput() from the list of processes. More...
void	Clear ()
	It executes the Clear() from the list of processes. More...
Input and output
virtual std::string	Info () const
	Turn back information as a string. More...
virtual void	PrintInfo (std::ostream &rOStream) const
	Print information about this object. More...
virtual void	PrintData (std::ostream &rOStream) const
	Print object's data. More...

Type Definitions
using	ObjectType = pybind11::object
	The object type in python. More...
using	ListType = pybind11::list
	The list [] of python. More...
	KRATOS_CLASS_POINTER_DEFINITION (ProcessFactoryUtility)
	Counted pointer of ProcessFactoryUtility. More...

Serialization
class	Serializer

Detailed Description

This is a experimental process factory utility.

This class is used in order to interoperate between c++ and python

Author

Vicente Mataix Ferrandiz

Member Typedef Documentation

ListType

using Kratos::ProcessFactoryUtility::ListType = pybind11::list

The list [] of python.

ObjectType

using Kratos::ProcessFactoryUtility::ObjectType = pybind11::object

The object type in python.

Constructor & Destructor Documentation

ProcessFactoryUtility() [1/3]

Kratos::ProcessFactoryUtility::ProcessFactoryUtility ( )

default

Default constructors.

ProcessFactoryUtility() [2/3]

Kratos::ProcessFactoryUtility::ProcessFactoryUtility

(

ListType &

ProcessesList

)

Constructor using a list of processes.

Parameters

ProcessesList

List of processes that will be used to build the vector of processes

ProcessFactoryUtility() [3/3]

Kratos::ProcessFactoryUtility::ProcessFactoryUtility

(

ObjectType &

rProcess

)

Constructor using just one process.

Parameters

rProcess

The process that will be added at the begining of the vector of processes

Note

This constructor overrides the previous ones ("everything" is an object, so here I try first to work as it is a list)

~ProcessFactoryUtility()

virtual Kratos::ProcessFactoryUtility::~ProcessFactoryUtility ( )

virtualdefault

Destructor.

Member Function Documentation

AddProcess()

void Kratos::ProcessFactoryUtility::AddProcess

(

ObjectType &

rProcess

)

It add new process to the existing process list.

Parameters

rProcess

The process that will be appended at the vector of processes

AddProcesses()

void Kratos::ProcessFactoryUtility::AddProcesses

(

ListType &

ProcessesList

)

It add new processes to the existing process list.

Parameters

ProcessesList

List of processes that will be appended the vector of processes

Clear()

void Kratos::ProcessFactoryUtility::Clear

(

)

It executes the Clear() from the list of processes.

ExecuteAfterOutputStep()

void Kratos::ProcessFactoryUtility::ExecuteAfterOutputStep

(

)

It executes the ExecuteAfterOutputStep() from the list of processes.

ExecuteBeforeOutputStep()

void Kratos::ProcessFactoryUtility::ExecuteBeforeOutputStep

(

)

It executes the ExecuteBeforeOutputStep() from the list of processes.

ExecuteBeforeSolutionLoop()

void Kratos::ProcessFactoryUtility::ExecuteBeforeSolutionLoop

(

)

It executes the ExecuteBeforeSolutionLoop() from the list of processes.

ExecuteFinalize()

void Kratos::ProcessFactoryUtility::ExecuteFinalize

(

)

It executes the ExecuteFinalize() from the list of processes.

ExecuteFinalizeSolutionStep()

void Kratos::ProcessFactoryUtility::ExecuteFinalizeSolutionStep

(

)

It executes the ExecuteFinalizeSolutionStep() from the list of processes.

ExecuteInitialize()

void Kratos::ProcessFactoryUtility::ExecuteInitialize

(

)

It executes the ExecuteInitialize() from the list of processes.

ExecuteInitializeSolutionStep()

void Kratos::ProcessFactoryUtility::ExecuteInitializeSolutionStep

(

)

It executes the ExecuteInitializeSolutionStep() from the list of processes.

ExecuteMethod()

void Kratos::ProcessFactoryUtility::ExecuteMethod

(

const std::string &

rNameMethod

)

It executes the method considered in the input.

Parameters

rNameMethod

The method to be executed

Info()

virtual std::string Kratos::ProcessFactoryUtility::Info ( ) const

inlinevirtual

Turn back information as a string.

IsOutputStep()

void Kratos::ProcessFactoryUtility::IsOutputStep

(

)

It executes the IsOutputStep() from the list of processes.

KRATOS_CLASS_POINTER_DEFINITION()

Kratos::ProcessFactoryUtility::KRATOS_CLASS_POINTER_DEFINITION

(

ProcessFactoryUtility

)

Counted pointer of ProcessFactoryUtility.

operator=()

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

default

Assignment operator.

PrintData()

virtual void Kratos::ProcessFactoryUtility::PrintData ( std::ostream &  rOStream ) const

inlinevirtual

Print object's data.

PrintInfo()

virtual void Kratos::ProcessFactoryUtility::PrintInfo ( std::ostream &  rOStream ) const

inlinevirtual

Print information about this object.

PrintOutput()

void Kratos::ProcessFactoryUtility::PrintOutput

(

)

It executes the PrintOutput() from the list of processes.

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/applications/ContactStructuralMechanicsApplication/custom_python/process_factory_utility.h
• /home/runner/work/Documentation/Documentation/master/applications/ContactStructuralMechanicsApplication/custom_python/process_factory_utility.cpp