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 Member Functions | List of all members
Kratos::EntitiesEraseProcess< TEntity > Class Template Reference

This process removes the entities from a model part with the flag TO_ERASE. More...

#include <entity_erase_process.h>

Inheritance diagram for Kratos::EntitiesEraseProcess< TEntity >:
Collaboration diagram for Kratos::EntitiesEraseProcess< TEntity >:

Public Member Functions

void Execute ()
 Execute method is used to execute the Process algorithms. More...
 
void Execute ()
 Execute method is used to execute the Process algorithms. More...
 
void Execute ()
 Execute method is used to execute the Process algorithms. More...
 
void Execute ()
 Execute method is used to execute the Process algorithms. More...
 
Type Definitions
 KRATOS_CLASS_POINTER_DEFINITION (EntitiesEraseProcess)
 Pointer definition of EntitiesEraseProcess. More...
 
Life Cycle
 EntitiesEraseProcess (ModelPart &rModelPart, const Flags Options=EntitiesEraseProcessFlags::REMOVE_FROM_ALL_LEVELS.AsFalse()|EntitiesEraseProcessFlags::ERASE_ALL_ENTITIES.AsFalse())
 The default parameters. More...
 
 EntitiesEraseProcess (ModelPart &rModelPart, Parameters ThisParameters)
 The default parameters (with parameters) More...
 
 ~EntitiesEraseProcess () override
 Destructor. More...
 
Operators
void operator() ()
 
Operations
void Execute () override
 Execute method is used to execute the Process algorithms. More...
 
const Parameters GetDefaultParameters () const override
 This method provides the defaults parameters to avoid conflicts between the different constructors. More...
 
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::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 ExecuteInitialize ()
 This function is designed for being called at the beginning of the computations right after reading the model and the groups. 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 ExecuteInitializeSolutionStep ()
 This function will be executed at every time step BEFORE performing the solve phase. 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...
 
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::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...
 

Additional Inherited Members

- 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

template<class TEntity>
class Kratos::EntitiesEraseProcess< TEntity >

This process removes the entities from a model part with the flag TO_ERASE.

It does some things additionally:

Constructor & Destructor Documentation

◆ EntitiesEraseProcess() [1/2]

template<class TEntity >
Kratos::EntitiesEraseProcess< TEntity >::EntitiesEraseProcess ( ModelPart rModelPart,
const Flags  Options = EntitiesEraseProcessFlags::REMOVE_FROM_ALL_LEVELS.AsFalse() | EntitiesEraseProcessFlags::ERASE_ALL_ENTITIES.AsFalse() 
)
explicit

The default parameters.

Parameters
rModelPartThe model part where remove the entities
OptionsThe flags definitions

◆ EntitiesEraseProcess() [2/2]

template<class TEntity >
Kratos::EntitiesEraseProcess< TEntity >::EntitiesEraseProcess ( ModelPart rModelPart,
Parameters  ThisParameters 
)
explicit

The default parameters (with parameters)

Parameters
rModelPartThe model part where remove the entities
ThisParametersThe configuration parameters

◆ ~EntitiesEraseProcess()

template<class TEntity >
Kratos::EntitiesEraseProcess< TEntity >::~EntitiesEraseProcess ( )
inlineoverride

Destructor.

Member Function Documentation

◆ Execute() [1/5]

void Kratos::EntitiesEraseProcess< Node >::Execute ( )
virtual

Execute method is used to execute the Process algorithms.

Reimplemented from Kratos::Process.

◆ Execute() [2/5]

void Kratos::EntitiesEraseProcess< Element >::Execute ( )
virtual

Execute method is used to execute the Process algorithms.

Reimplemented from Kratos::Process.

◆ Execute() [3/5]

void Kratos::EntitiesEraseProcess< Condition >::Execute ( )
virtual

Execute method is used to execute the Process algorithms.

Reimplemented from Kratos::Process.

◆ Execute() [4/5]

Execute method is used to execute the Process algorithms.

Reimplemented from Kratos::Process.

◆ Execute() [5/5]

template<class TEntity >
void Kratos::EntitiesEraseProcess< TEntity >::Execute ( )
overridevirtual

Execute method is used to execute the Process algorithms.

Reimplemented from Kratos::Process.

◆ GetDefaultParameters()

template<class TEntity >
const Parameters Kratos::EntitiesEraseProcess< TEntity >::GetDefaultParameters
overridevirtual

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

Reimplemented from Kratos::Process.

◆ Info()

template<class TEntity >
std::string Kratos::EntitiesEraseProcess< TEntity >::Info ( ) const
inlineoverridevirtual

Turn back information as a string.

Reimplemented from Kratos::Flags.

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<class TEntity >
Kratos::EntitiesEraseProcess< TEntity >::KRATOS_CLASS_POINTER_DEFINITION ( EntitiesEraseProcess< TEntity >  )

Pointer definition of EntitiesEraseProcess.

◆ operator()()

template<class TEntity >
void Kratos::EntitiesEraseProcess< TEntity >::operator() ( )
inline

◆ PrintData()

template<class TEntity >
void Kratos::EntitiesEraseProcess< TEntity >::PrintData ( std::ostream &  rOStream) const
inlineoverridevirtual

Print object's data.

Reimplemented from Kratos::Flags.

◆ PrintInfo()

template<class TEntity >
void Kratos::EntitiesEraseProcess< TEntity >::PrintInfo ( std::ostream &  rOStream) const
inlineoverridevirtual

Print information about this object.

Reimplemented from Kratos::Flags.


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