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 Member Functions | Protected Attributes | List of all members
Kratos::PoromechanicsFaceLoadControlModuleProcess Class Reference

FaceLoad control module for displacements. More...

#include <poromechanics_face_load_control_module_process.hpp>

Inheritance diagram for Kratos::PoromechanicsFaceLoadControlModuleProcess:
Collaboration diagram for Kratos::PoromechanicsFaceLoadControlModuleProcess:

Public Types

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 (PoromechanicsFaceLoadControlModuleProcess)
 
 PoromechanicsFaceLoadControlModuleProcess (ModelPart &rModelPart, Parameters rParameters)
 Constructor. More...
 
 ~PoromechanicsFaceLoadControlModuleProcess () override
 Destructor. More...
 
void Execute () override
 Execute method is used to execute the PoromechanicsFaceLoadControlModuleProcess algorithms. More...
 
void ExecuteInitialize () override
 
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...
 
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 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 Member Functions

virtual double GetTargetReaction (const double &time)
 
virtual double UpdateVectorOfHistoricalForcesAndComputeNewAverage (const double &last_reaction)
 
virtual double CalculateReactionForce ()
 
virtual double EstimateStiffness (const double &rReactionForce, const double &rDeltaTime)
 

Protected Attributes

ModelPartmrModelPart
 Member Variables. More...
 
std::string mDisplacementName
 
std::string mReactionName
 
std::string mAverageReactionName
 
std::string mTargetReactionName
 
std::string mLoadingVelocityName
 
unsigned int mFaceLoadTableId
 
double mVelocity
 
double mLimitVelocity
 
double mVelocityFactor
 
double mReactionForceOld
 
double mForceIncrementTolerance
 
double mStiffness
 
bool mUpdateStiffness
 
std::vector< doublemVectorOfLastForces
 
double mForceAveragingTime
 

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)
 

Detailed Description

FaceLoad control module for displacements.

Member Typedef Documentation

◆ TableType

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

Constructor & Destructor Documentation

◆ PoromechanicsFaceLoadControlModuleProcess()

Kratos::PoromechanicsFaceLoadControlModuleProcess::PoromechanicsFaceLoadControlModuleProcess ( ModelPart rModelPart,
Parameters  rParameters 
)
inline

Constructor.


◆ ~PoromechanicsFaceLoadControlModuleProcess()

Kratos::PoromechanicsFaceLoadControlModuleProcess::~PoromechanicsFaceLoadControlModuleProcess ( )
inlineoverride

Destructor.


Member Function Documentation

◆ CalculateReactionForce()

virtual double Kratos::PoromechanicsFaceLoadControlModuleProcess::CalculateReactionForce ( )
inlineprotectedvirtual

◆ EstimateStiffness()

virtual double Kratos::PoromechanicsFaceLoadControlModuleProcess::EstimateStiffness ( const double rReactionForce,
const double rDeltaTime 
)
inlineprotectedvirtual

◆ Execute()

void Kratos::PoromechanicsFaceLoadControlModuleProcess::Execute ( )
inlineoverridevirtual

Execute method is used to execute the PoromechanicsFaceLoadControlModuleProcess algorithms.


Reimplemented from Kratos::Process.

◆ ExecuteFinalizeSolutionStep()

void Kratos::PoromechanicsFaceLoadControlModuleProcess::ExecuteFinalizeSolutionStep ( )
inlineoverridevirtual

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

Reimplemented from Kratos::Process.

◆ ExecuteInitialize()

void Kratos::PoromechanicsFaceLoadControlModuleProcess::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.

◆ ExecuteInitializeSolutionStep()

void Kratos::PoromechanicsFaceLoadControlModuleProcess::ExecuteInitializeSolutionStep ( )
inlineoverridevirtual

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

Reimplemented from Kratos::Process.

◆ GetTargetReaction()

virtual double Kratos::PoromechanicsFaceLoadControlModuleProcess::GetTargetReaction ( const double time)
inlineprotectedvirtual

◆ Info()

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

Turn back information as a string.

Reimplemented from Kratos::Process.

◆ KRATOS_CLASS_POINTER_DEFINITION()

Kratos::PoromechanicsFaceLoadControlModuleProcess::KRATOS_CLASS_POINTER_DEFINITION ( PoromechanicsFaceLoadControlModuleProcess  )

◆ PrintData()

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

Print object's data.

Reimplemented from Kratos::Process.

◆ PrintInfo()

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

Print information about this object.

Reimplemented from Kratos::Process.

◆ UpdateVectorOfHistoricalForcesAndComputeNewAverage()

virtual double Kratos::PoromechanicsFaceLoadControlModuleProcess::UpdateVectorOfHistoricalForcesAndComputeNewAverage ( const double last_reaction)
inlineprotectedvirtual

Member Data Documentation

◆ mAverageReactionName

std::string Kratos::PoromechanicsFaceLoadControlModuleProcess::mAverageReactionName
protected

◆ mDisplacementName

std::string Kratos::PoromechanicsFaceLoadControlModuleProcess::mDisplacementName
protected

◆ mFaceLoadTableId

unsigned int Kratos::PoromechanicsFaceLoadControlModuleProcess::mFaceLoadTableId
protected

◆ mForceAveragingTime

double Kratos::PoromechanicsFaceLoadControlModuleProcess::mForceAveragingTime
protected

◆ mForceIncrementTolerance

double Kratos::PoromechanicsFaceLoadControlModuleProcess::mForceIncrementTolerance
protected

◆ mLimitVelocity

double Kratos::PoromechanicsFaceLoadControlModuleProcess::mLimitVelocity
protected

◆ mLoadingVelocityName

std::string Kratos::PoromechanicsFaceLoadControlModuleProcess::mLoadingVelocityName
protected

◆ mReactionForceOld

double Kratos::PoromechanicsFaceLoadControlModuleProcess::mReactionForceOld
protected

◆ mReactionName

std::string Kratos::PoromechanicsFaceLoadControlModuleProcess::mReactionName
protected

◆ mrModelPart

ModelPart& Kratos::PoromechanicsFaceLoadControlModuleProcess::mrModelPart
protected

Member Variables.


◆ mStiffness

double Kratos::PoromechanicsFaceLoadControlModuleProcess::mStiffness
protected

◆ mTargetReactionName

std::string Kratos::PoromechanicsFaceLoadControlModuleProcess::mTargetReactionName
protected

◆ mUpdateStiffness

bool Kratos::PoromechanicsFaceLoadControlModuleProcess::mUpdateStiffness
protected

◆ mVectorOfLastForces

std::vector<double> Kratos::PoromechanicsFaceLoadControlModuleProcess::mVectorOfLastForces
protected

◆ mVelocity

double Kratos::PoromechanicsFaceLoadControlModuleProcess::mVelocity
protected

◆ mVelocityFactor

double Kratos::PoromechanicsFaceLoadControlModuleProcess::mVelocityFactor
protected

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