KratosMultiphysics
KRATOS Multiphysics (Kratos) is a framework for building parallel, multi-disciplinary simulation software, aiming at modularity, extensibility, and high performance. Kratos is written in C++, and counts with an extensive Python interface.
Public Types | Public Member Functions | Protected Attributes | List of all members
Kratos::ApplyComponentTableProcess Class Reference

#include <apply_component_table_process.hpp>

Inheritance diagram for Kratos::ApplyComponentTableProcess:
Collaboration diagram for Kratos::ApplyComponentTableProcess:

Public Types

typedef Table< double, doubleTableType
 Defining a table with double argument and result type as table type. More...
 
using TableType = Table< double, double >
 Defining a table with double argument and result type as table type. More...
 
typedef Table< double, doubleTableType
 Defining a table with double argument and result type as table type. 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
 

Public Member Functions

 KRATOS_CLASS_POINTER_DEFINITION (ApplyComponentTableProcess)
 
 ApplyComponentTableProcess (ModelPart &model_part, Parameters rParameters)
 Constructor. More...
 
 ~ApplyComponentTableProcess () override
 Destructor. More...
 
void Execute () override
 Execute method is used to execute the ApplyComponentTableProcess algorithms. More...
 
void ExecuteInitialize () override
 
void ExecuteInitializeSolutionStep () override
 this function will be executed at every time step BEFORE performing the solve phase More...
 
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...
 
 KRATOS_CLASS_POINTER_DEFINITION (ApplyComponentTableProcess)
 
 ApplyComponentTableProcess (ModelPart &model_part, Parameters rParameters)
 
 ApplyComponentTableProcess (const ApplyComponentTableProcess &)=delete
 
ApplyComponentTableProcessoperator= (const ApplyComponentTableProcess &)=delete
 
 ~ApplyComponentTableProcess () override=default
 
void ExecuteInitialize () override
 
void ExecuteInitializeSolutionStep () override
 this function will be executed at every time step BEFORE performing the solve phase More...
 
std::string Info () const override
 Turn back information as a string. More...
 
 KRATOS_CLASS_POINTER_DEFINITION (ApplyComponentTableProcess)
 
 ApplyComponentTableProcess (ModelPart &model_part, Parameters rParameters)
 Constructor. More...
 
 ~ApplyComponentTableProcess () override
 Destructor. More...
 
void Execute () override
 Execute method is used to execute the ApplyComponentTableProcess algorithms. More...
 
void ExecuteInitialize () override
 
void ExecuteInitializeSolutionStep () override
 this function will be executed at every time step BEFORE performing the solve phase More...
 
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 ExecuteBeforeSolutionLoop ()
 This function is designed for being execute once before the solution loop but after all of the solvers where built. More...
 
virtual void ExecuteFinalizeSolutionStep ()
 This function will be executed at every time step AFTER performing the solve phase. 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 int Check ()
 This function is designed for being called after ExecuteInitialize ONCE to verify that the input is correct. More...
 
virtual void Clear ()
 This method clears the assignation of the conditions. More...
 
virtual const Parameters GetDefaultParameters () const
 This method provides the defaults parameters to avoid conflicts between the different constructors. More...
 
- Public Member Functions inherited from Kratos::Flags
Flagsoperator= (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 Flagsoperator|= (const Flags &Other)
 
const Flagsoperator&= (const Flags &Other)
 
 Flags ()
 Default constructor. More...
 
 Flags (Flags const &rOther)
 Copy constructor. More...
 
virtual ~Flags ()
 Destructor. More...
 

Protected Attributes

ModelPartmrModelPart
 Member Variables. More...
 
std::string mVariableName
 
bool mIsFixed
 
double mInitialValue
 
TableType::Pointer mpTable
 
double mTimeUnitConverter
 
ModelPartmr_model_part
 Member Variables. More...
 
std::string mvariable_name
 
bool mis_fixed
 
double minitial_value
 

Additional Inherited Members

- Static Public Member Functions inherited from Kratos::Flags
static const Flags AllDefined ()
 
static const Flags AllTrue ()
 
static Flags Create (IndexType ThisPosition, bool Value=true)
 

Member Typedef Documentation

◆ TableType [1/3]

Defining a table with double argument and result type as table type.

◆ TableType [2/3]

Defining a table with double argument and result type as table type.

◆ TableType [3/3]

Defining a table with double argument and result type as table type.

Constructor & Destructor Documentation

◆ ApplyComponentTableProcess() [1/4]

Kratos::ApplyComponentTableProcess::ApplyComponentTableProcess ( ModelPart model_part,
Parameters  rParameters 
)
inline

Constructor.


◆ ~ApplyComponentTableProcess() [1/3]

Kratos::ApplyComponentTableProcess::~ApplyComponentTableProcess ( )
inlineoverride

Destructor.


◆ ApplyComponentTableProcess() [2/4]

Kratos::ApplyComponentTableProcess::ApplyComponentTableProcess ( ModelPart model_part,
Parameters  rParameters 
)
inline

◆ ApplyComponentTableProcess() [3/4]

Kratos::ApplyComponentTableProcess::ApplyComponentTableProcess ( const ApplyComponentTableProcess )
delete

◆ ~ApplyComponentTableProcess() [2/3]

Kratos::ApplyComponentTableProcess::~ApplyComponentTableProcess ( )
overridedefault

◆ ApplyComponentTableProcess() [4/4]

Kratos::ApplyComponentTableProcess::ApplyComponentTableProcess ( ModelPart model_part,
Parameters  rParameters 
)
inline

Constructor.


◆ ~ApplyComponentTableProcess() [3/3]

Kratos::ApplyComponentTableProcess::~ApplyComponentTableProcess ( )
inlineoverride

Destructor.


Member Function Documentation

◆ Execute() [1/2]

void Kratos::ApplyComponentTableProcess::Execute ( )
inlineoverridevirtual

Execute method is used to execute the ApplyComponentTableProcess algorithms.


Reimplemented from Kratos::Process.

Reimplemented in Kratos::ApplyDoubleTableProcess, and Kratos::ApplyDoubleTableProcess.

◆ Execute() [2/2]

void Kratos::ApplyComponentTableProcess::Execute ( )
inlineoverridevirtual

Execute method is used to execute the ApplyComponentTableProcess algorithms.


Reimplemented from Kratos::Process.

Reimplemented in Kratos::ApplyDoubleTableProcess.

◆ ExecuteInitialize() [1/3]

void Kratos::ApplyComponentTableProcess::ExecuteInitialize ( )
inlineoverridevirtual

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.

Reimplemented in Kratos::ApplyDoubleTableProcess, and Kratos::ApplyDoubleTableProcess.

◆ ExecuteInitialize() [2/3]

void Kratos::ApplyComponentTableProcess::ExecuteInitialize ( )
inlineoverridevirtual

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.

Reimplemented in Kratos::ApplyDoubleTableProcess.

◆ ExecuteInitialize() [3/3]

void Kratos::ApplyComponentTableProcess::ExecuteInitialize ( )
inlineoverridevirtual

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.

Reimplemented in Kratos::ApplyDoubleTableProcess.

◆ ExecuteInitializeSolutionStep() [1/3]

void Kratos::ApplyComponentTableProcess::ExecuteInitializeSolutionStep ( )
inlineoverridevirtual

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

Reimplemented from Kratos::Process.

Reimplemented in Kratos::ApplyDoubleTableProcess, and Kratos::ApplyDoubleTableProcess.

◆ ExecuteInitializeSolutionStep() [2/3]

void Kratos::ApplyComponentTableProcess::ExecuteInitializeSolutionStep ( )
inlineoverridevirtual

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

Reimplemented from Kratos::Process.

Reimplemented in Kratos::ApplyDoubleTableProcess.

◆ ExecuteInitializeSolutionStep() [3/3]

void Kratos::ApplyComponentTableProcess::ExecuteInitializeSolutionStep ( )
inlineoverridevirtual

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

Reimplemented from Kratos::Process.

Reimplemented in Kratos::ApplyDoubleTableProcess.

◆ Info() [1/3]

std::string Kratos::ApplyComponentTableProcess::Info ( ) const
inlineoverridevirtual

Turn back information as a string.

Reimplemented from Kratos::Process.

Reimplemented in Kratos::ApplyDoubleTableProcess, and Kratos::ApplyDoubleTableProcess.

◆ Info() [2/3]

std::string Kratos::ApplyComponentTableProcess::Info ( ) const
inlineoverridevirtual

Turn back information as a string.

Reimplemented from Kratos::Process.

Reimplemented in Kratos::ApplyDoubleTableProcess.

◆ Info() [3/3]

std::string Kratos::ApplyComponentTableProcess::Info ( ) const
inlineoverridevirtual

Turn back information as a string.

Reimplemented from Kratos::Process.

Reimplemented in Kratos::ApplyDoubleTableProcess.

◆ KRATOS_CLASS_POINTER_DEFINITION() [1/3]

Kratos::ApplyComponentTableProcess::KRATOS_CLASS_POINTER_DEFINITION ( ApplyComponentTableProcess  )

◆ KRATOS_CLASS_POINTER_DEFINITION() [2/3]

Kratos::ApplyComponentTableProcess::KRATOS_CLASS_POINTER_DEFINITION ( ApplyComponentTableProcess  )

◆ KRATOS_CLASS_POINTER_DEFINITION() [3/3]

Kratos::ApplyComponentTableProcess::KRATOS_CLASS_POINTER_DEFINITION ( ApplyComponentTableProcess  )

◆ operator=()

ApplyComponentTableProcess& Kratos::ApplyComponentTableProcess::operator= ( const ApplyComponentTableProcess )
delete

◆ PrintData() [1/2]

void Kratos::ApplyComponentTableProcess::PrintData ( std::ostream &  rOStream) const
inlineoverridevirtual

Print object's data.

Reimplemented from Kratos::Process.

Reimplemented in Kratos::ApplyDoubleTableProcess, and Kratos::ApplyDoubleTableProcess.

◆ PrintData() [2/2]

void Kratos::ApplyComponentTableProcess::PrintData ( std::ostream &  rOStream) const
inlineoverridevirtual

Print object's data.

Reimplemented from Kratos::Process.

Reimplemented in Kratos::ApplyDoubleTableProcess.

◆ PrintInfo() [1/2]

void Kratos::ApplyComponentTableProcess::PrintInfo ( std::ostream &  rOStream) const
inlineoverridevirtual

Print information about this object.

Reimplemented from Kratos::Process.

Reimplemented in Kratos::ApplyDoubleTableProcess, and Kratos::ApplyDoubleTableProcess.

◆ PrintInfo() [2/2]

void Kratos::ApplyComponentTableProcess::PrintInfo ( std::ostream &  rOStream) const
inlineoverridevirtual

Print information about this object.

Reimplemented from Kratos::Process.

Reimplemented in Kratos::ApplyDoubleTableProcess.

Member Data Documentation

◆ minitial_value

double Kratos::ApplyComponentTableProcess::minitial_value
protected

◆ mInitialValue

double Kratos::ApplyComponentTableProcess::mInitialValue
protected

◆ mis_fixed

bool Kratos::ApplyComponentTableProcess::mis_fixed
protected

◆ mIsFixed

bool Kratos::ApplyComponentTableProcess::mIsFixed
protected

◆ mpTable

TableType::Pointer Kratos::ApplyComponentTableProcess::mpTable
protected

◆ mr_model_part

ModelPart& Kratos::ApplyComponentTableProcess::mr_model_part
protected

Member Variables.


◆ mrModelPart

ModelPart & Kratos::ApplyComponentTableProcess::mrModelPart
protected

Member Variables.


◆ mTimeUnitConverter

double Kratos::ApplyComponentTableProcess::mTimeUnitConverter
protected

◆ mvariable_name

std::string Kratos::ApplyComponentTableProcess::mvariable_name
protected

◆ mVariableName

std::string Kratos::ApplyComponentTableProcess::mVariableName
protected

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