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.
List of all members
Kratos::AssignScalarFieldToPfemEntitiesProcess Class Reference

The base class for assigning a value to scalar variables or array_1d components processes in Kratos. More...

#include <assign_scalar_field_to_pfem_entities_process.hpp>

Inheritance diagram for Kratos::AssignScalarFieldToPfemEntitiesProcess:
Collaboration diagram for Kratos::AssignScalarFieldToPfemEntitiesProcess:

Public Member Functions

Life Cycle
 AssignScalarFieldToPfemEntitiesProcess (ModelPart &rModelPart, pybind11::object &pPyObject, const std::string &pPyMethodName, const bool SpatialFieldFunction, Parameters rParameters)
 
 AssignScalarFieldToPfemEntitiesProcess (ModelPart &rModelPart, pybind11::object &pPyObject, const std::string &pPyMethodName, const bool SpatialFieldFunction)
 
 ~AssignScalarFieldToPfemEntitiesProcess () override
 Destructor. More...
 
Operators
void operator() ()
 This operator is provided to call the process as a function and simply calls the Execute method. More...
 
Operations
void Execute () override
 Execute method is used to execute the AssignScalarFieldToPfemEntitiesProcess algorithms. More...
 
void ExecuteInitialize () override
 
void ExecuteBeforeSolutionLoop () 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...
 
void ExecuteBeforeOutputStep () override
 this function will be executed at every time step BEFORE writing the output More...
 
void ExecuteAfterOutputStep () override
 this function will be executed at every time step AFTER writing the output More...
 
void ExecuteFinalize () override
 
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::AssignScalarVariableToPfemEntitiesProcess
 AssignScalarVariableToPfemEntitiesProcess (ModelPart &rModelPart)
 
 AssignScalarVariableToPfemEntitiesProcess (ModelPart &rModelPart, Parameters rParameters)
 
 ~AssignScalarVariableToPfemEntitiesProcess () override
 Destructor. More...
 
void operator() ()
 This operator is provided to call the process as a function and simply calls the Execute method. More...
 
void Execute () override
 Execute method is used to execute the AssignScalarVariableToPfemEntitiesProcess algorithms. More...
 
void ExecuteInitialize () override
 
void ExecuteBeforeSolutionLoop () 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...
 
void ExecuteBeforeOutputStep () override
 this function will be executed at every time step BEFORE writing the output More...
 
void ExecuteAfterOutputStep () override
 this function will be executed at every time step AFTER writing the output More...
 
void ExecuteFinalize () override
 
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 (AssignScalarVariableToPfemEntitiesProcess)
 Pointer definition of AssignScalarVariableToPfemEntitiesProcess. 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 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

Protected Operators
 AssignScalarFieldToPfemEntitiesProcess (AssignScalarFieldToPfemEntitiesProcess const &rOther)
 Copy constructor. More...
 
Protected Operations
void LocalAxesTransform (const double &rX_global, const double &rY_global, const double &rZ_global, double &rx_local, double &ry_local, double &rz_local)
 
void CallFunction (const Node::Pointer &pNode, const double &time, double &rValue)
 
void CallFunction (const Condition::Pointer &pCondition, const double &time, Vector &rValue)
 
void CallFunction (const Element::Pointer &pElement, const double &time, Vector &rValue)
 
template<class TVarType >
void AssignValueToNodes (TVarType &rVariable, const double &rTime)
 
template<class TVarType >
void AssignValueToConditions (TVarType &rVariable, const double &rTime)
 
template<class TVarType , class TDataType >
void AssignValueToConditions (TVarType &rVariable, const TDataType Value)
 
template<class TVarType >
void AssignValueToElements (TVarType &rVariable, const double &rTime)
 
- Protected Member Functions inherited from Kratos::AssignScalarVariableToPfemEntitiesProcess
 AssignScalarVariableToPfemEntitiesProcess (AssignScalarVariableToPfemEntitiesProcess const &rOther)
 Copy constructor. More...
 
void SetAssignmentType (std::string method, AssignmentType &rAssignment)
 
template<class TVarType , class TDataType >
void DirectAssignValue (ModelPart::NodeType &rNode, const TVarType &rVariable, const TDataType &value)
 
template<class TVarType , class TDataType >
void AddAssignValue (ModelPart::NodeType &rNode, const TVarType &rVariable, const TDataType &value)
 
template<class TVarType , class TDataType >
void SubtractAssignValue (ModelPart::NodeType &rNode, const TVarType &rVariable, const TDataType &value)
 
template<class TVarType , class TDataType >
void MultiplyAssignValue (ModelPart::NodeType &rNode, const TVarType &rVariable, const TDataType &value)
 
template<class TVarType , class TDataType >
void DivideAssignValue (ModelPart::NodeType &rNode, const TVarType &rVariable, const TDataType &value)
 
template<class TEntityType , class TVarType , class TDataType >
void DirectAssignValue (TEntityType &rEntity, const TVarType &rVariable, const TDataType &value)
 
template<class TEntityType , class TVarType , class TDataType >
void AddAssignValue (TEntityType &rEntity, const TVarType &rVariable, const TDataType &value)
 
template<class TEntityType , class TVarType , class TDataType >
void SubtractAssignValue (TEntityType &rEntity, const TVarType &rVariable, const TDataType &value)
 
template<class TEntityType , class TVarType , class TDataType >
void MultiplyAssignValue (TEntityType &rEntity, const TVarType &rVariable, const TDataType value)
 
template<class TEntityType , class TVarType , class TDataType >
void DivideAssignValue (TEntityType &rEntity, const TVarType &rVariable, const TDataType &value)
 
template<class TEntityType >
void MultiplyAssignValue (TEntityType &rEntity, const Variable< Vector > &rVariable, const Vector &value)
 
template<class TEntityType >
void DivideAssignValue (TEntityType &rEntity, const Variable< Vector > &rVariable, const Vector &value)
 
template<class TEntityType >
void MultiplyAssignValue (TEntityType &rEntity, const Variable< array_1d< double, 3 >> &rVariable, const array_1d< double, 3 > &value)
 
template<class TEntityType >
void DivideAssignValue (TEntityType &rEntity, const Variable< array_1d< double, 3 >> &rVariable, const array_1d< double, 3 > &value)
 
template<class TMethodPointerType >
TMethodPointerType GetAssignmentMethod ()
 

Protected Attributes

Protected member Variables
pybind11::object mPyObject
 
std::string mPyMethodName
 
Vector mLocalOrigin
 
Matrix mTransformationMatrix
 
bool mIsSpatialField
 
bool mHasLocalOrigin
 
bool mHasLocalAxes
 
- Protected Attributes inherited from Kratos::AssignScalarVariableToPfemEntitiesProcess
ModelPartmrModelPart
 
std::string mvariable_name
 
EntityType mEntity
 
AssignmentType mAssignment
 

Type Definitions

typedef AssignScalarVariableToPfemEntitiesProcess BaseType
 
 KRATOS_CLASS_POINTER_DEFINITION (AssignScalarFieldToPfemEntitiesProcess)
 Pointer definition of AssignScalarFieldToPfemEntitiesProcess. More...
 

Additional Inherited Members

- Public Types inherited from Kratos::AssignScalarVariableToPfemEntitiesProcess
enum class  EntityType { NODES , CONDITIONS , ELEMENTS }
 
enum class  AssignmentType {
  DIRECT , ADDITION , SUBTRACTION , MULTIPLICATION ,
  DIVISION
}
 
- 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
 
- 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

The base class for assigning a value to scalar variables or array_1d components processes in Kratos.

This function assigns a value to a variable belonging to all of the nodes in a given mesh

Member Typedef Documentation

◆ BaseType

Constructor & Destructor Documentation

◆ AssignScalarFieldToPfemEntitiesProcess() [1/3]

Kratos::AssignScalarFieldToPfemEntitiesProcess::AssignScalarFieldToPfemEntitiesProcess ( ModelPart rModelPart,
pybind11::object &  pPyObject,
const std::string &  pPyMethodName,
const bool  SpatialFieldFunction,
Parameters  rParameters 
)
inline

◆ AssignScalarFieldToPfemEntitiesProcess() [2/3]

Kratos::AssignScalarFieldToPfemEntitiesProcess::AssignScalarFieldToPfemEntitiesProcess ( ModelPart rModelPart,
pybind11::object &  pPyObject,
const std::string &  pPyMethodName,
const bool  SpatialFieldFunction 
)
inline

◆ ~AssignScalarFieldToPfemEntitiesProcess()

Kratos::AssignScalarFieldToPfemEntitiesProcess::~AssignScalarFieldToPfemEntitiesProcess ( )
inlineoverride

Destructor.

◆ AssignScalarFieldToPfemEntitiesProcess() [3/3]

Kratos::AssignScalarFieldToPfemEntitiesProcess::AssignScalarFieldToPfemEntitiesProcess ( AssignScalarFieldToPfemEntitiesProcess const &  rOther)
protected

Copy constructor.

Member Function Documentation

◆ AssignValueToConditions() [1/2]

template<class TVarType >
void Kratos::AssignScalarFieldToPfemEntitiesProcess::AssignValueToConditions ( TVarType &  rVariable,
const double rTime 
)
inlineprotected

◆ AssignValueToConditions() [2/2]

template<class TVarType , class TDataType >
void Kratos::AssignScalarFieldToPfemEntitiesProcess::AssignValueToConditions ( TVarType &  rVariable,
const TDataType  Value 
)
inlineprotected

◆ AssignValueToElements()

template<class TVarType >
void Kratos::AssignScalarFieldToPfemEntitiesProcess::AssignValueToElements ( TVarType &  rVariable,
const double rTime 
)
inlineprotected

◆ AssignValueToNodes()

template<class TVarType >
void Kratos::AssignScalarFieldToPfemEntitiesProcess::AssignValueToNodes ( TVarType &  rVariable,
const double rTime 
)
inlineprotected

◆ CallFunction() [1/3]

void Kratos::AssignScalarFieldToPfemEntitiesProcess::CallFunction ( const Condition::Pointer &  pCondition,
const double time,
Vector rValue 
)
inlineprotected

◆ CallFunction() [2/3]

void Kratos::AssignScalarFieldToPfemEntitiesProcess::CallFunction ( const Element::Pointer &  pElement,
const double time,
Vector rValue 
)
inlineprotected

◆ CallFunction() [3/3]

void Kratos::AssignScalarFieldToPfemEntitiesProcess::CallFunction ( const Node::Pointer &  pNode,
const double time,
double rValue 
)
inlineprotected

◆ Execute()

void Kratos::AssignScalarFieldToPfemEntitiesProcess::Execute ( )
inlineoverridevirtual

Execute method is used to execute the AssignScalarFieldToPfemEntitiesProcess algorithms.

Reimplemented from Kratos::Process.

Reimplemented in Kratos::AssignVectorFieldToPfemEntitiesProcess.

◆ ExecuteAfterOutputStep()

void Kratos::AssignScalarFieldToPfemEntitiesProcess::ExecuteAfterOutputStep ( )
inlineoverridevirtual

this function will be executed at every time step AFTER writing the output

Reimplemented from Kratos::Process.

Reimplemented in Kratos::AssignVectorFieldToPfemEntitiesProcess.

◆ ExecuteBeforeOutputStep()

void Kratos::AssignScalarFieldToPfemEntitiesProcess::ExecuteBeforeOutputStep ( )
inlineoverridevirtual

this function will be executed at every time step BEFORE writing the output

Reimplemented from Kratos::Process.

Reimplemented in Kratos::AssignVectorFieldToPfemEntitiesProcess.

◆ ExecuteBeforeSolutionLoop()

void Kratos::AssignScalarFieldToPfemEntitiesProcess::ExecuteBeforeSolutionLoop ( )
inlineoverridevirtual

this function is designed for being execute once before the solution loop but after all of the solvers where built

Reimplemented from Kratos::Process.

Reimplemented in Kratos::AssignVectorFieldToPfemEntitiesProcess.

◆ ExecuteFinalize()

void Kratos::AssignScalarFieldToPfemEntitiesProcess::ExecuteFinalize ( )
inlineoverridevirtual

this function is designed for being called at the end of the computations right after reading the model and the groups

Reimplemented from Kratos::Process.

Reimplemented in Kratos::AssignVectorFieldToPfemEntitiesProcess.

◆ ExecuteFinalizeSolutionStep()

void Kratos::AssignScalarFieldToPfemEntitiesProcess::ExecuteFinalizeSolutionStep ( )
inlineoverridevirtual

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

Reimplemented from Kratos::Process.

Reimplemented in Kratos::AssignVectorFieldToPfemEntitiesProcess.

◆ ExecuteInitialize()

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

◆ ExecuteInitializeSolutionStep()

void Kratos::AssignScalarFieldToPfemEntitiesProcess::ExecuteInitializeSolutionStep ( )
inlineoverridevirtual

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

Reimplemented from Kratos::Process.

Reimplemented in Kratos::AssignVectorFieldToPfemEntitiesProcess.

◆ Info()

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

Turn back information as a string.

Reimplemented from Kratos::Process.

Reimplemented in Kratos::AssignVectorFieldToPfemEntitiesProcess.

◆ KRATOS_CLASS_POINTER_DEFINITION()

Kratos::AssignScalarFieldToPfemEntitiesProcess::KRATOS_CLASS_POINTER_DEFINITION ( AssignScalarFieldToPfemEntitiesProcess  )

◆ LocalAxesTransform()

void Kratos::AssignScalarFieldToPfemEntitiesProcess::LocalAxesTransform ( const double rX_global,
const double rY_global,
const double rZ_global,
double rx_local,
double ry_local,
double rz_local 
)
inlineprotected

◆ operator()()

void Kratos::AssignScalarFieldToPfemEntitiesProcess::operator() ( )
inline

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

◆ PrintData()

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

Print object's data.

Reimplemented from Kratos::Process.

Reimplemented in Kratos::AssignVectorFieldToPfemEntitiesProcess.

◆ PrintInfo()

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

Print information about this object.

Reimplemented from Kratos::Process.

Reimplemented in Kratos::AssignVectorFieldToPfemEntitiesProcess.

Member Data Documentation

◆ mHasLocalAxes

bool Kratos::AssignScalarFieldToPfemEntitiesProcess::mHasLocalAxes
protected

◆ mHasLocalOrigin

bool Kratos::AssignScalarFieldToPfemEntitiesProcess::mHasLocalOrigin
protected

◆ mIsSpatialField

bool Kratos::AssignScalarFieldToPfemEntitiesProcess::mIsSpatialField
protected

◆ mLocalOrigin

Vector Kratos::AssignScalarFieldToPfemEntitiesProcess::mLocalOrigin
protected

◆ mPyMethodName

std::string Kratos::AssignScalarFieldToPfemEntitiesProcess::mPyMethodName
protected

◆ mPyObject

pybind11::object Kratos::AssignScalarFieldToPfemEntitiesProcess::mPyObject
protected

◆ mTransformationMatrix

Matrix Kratos::AssignScalarFieldToPfemEntitiesProcess::mTransformationMatrix
protected

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