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 | List of all members
Kratos::SwimmingParticle< TBaseElement > Class Template Reference

#include <swimming_particle.h>

Inheritance diagram for Kratos::SwimmingParticle< TBaseElement >:
Collaboration diagram for Kratos::SwimmingParticle< TBaseElement >:

Public Types

typedef std::size_t IndexType
 
typedef Node NodeType
 
typedef Geometry< NodeTypeGeometryType
 
typedef Geometry< NodeType >::PointsArrayType NodesArrayType
 
typedef Properties PropertiesType
 

Public Member Functions

Type Definitions
 KRATOS_CLASS_INTRUSIVE_POINTER_DEFINITION (SwimmingParticle)
 Pointer definition of SwimmingParticle. More...
 

Life Cycle

std::vector< Node::Pointer > mNeighbourNodes
 
std::vector< doublemNeighbourNodesDistances
 
 SwimmingParticle ()
 Default constructor. More...
 
 SwimmingParticle (IndexType NewId, GeometryType::Pointer pGeometry)
 
 SwimmingParticle (IndexType NewId, NodesArrayType const &ThisNodes)
 
 SwimmingParticle (IndexType NewId, GeometryType::Pointer pGeometry, PropertiesType::Pointer pProperties)
 
Element::Pointer Create (IndexType NewId, NodesArrayType const &ThisNodes, PropertiesType::Pointer pProperties) const override
 
virtual ~SwimmingParticle ()
 Destructor. More...
 
SwimmingParticle< TBaseElement > & operator= (const SwimmingParticle< TBaseElement > &rOther)
 
virtual void CreateHydrodynamicInteractionLaws (const ProcessInfo &r_process_info)
 
void ComputeAdditionalForces (array_1d< double, 3 > &additionally_applied_force, array_1d< double, 3 > &additionally_applied_moment, const ProcessInfo &rCurrentProcessInfo, const array_1d< double, 3 > &gravity) override
 
virtual std::string Info () const override
 Turn back information as a string. More...
 
virtual void PrintInfo (std::ostream &rOStream) const override
 Print information about this object. More...
 
virtual void PrintData (std::ostream &rOStream) const override
 Print object's data. More...
 
void Calculate (const Variable< array_1d< double, 3 > > &rVariable, array_1d< double, 3 > &Output, const ProcessInfo &r_current_process_info) override
 
void MemberDeclarationFirstStep (const ProcessInfo &r_current_process_info) override
 
void AdditionalCalculate (const Variable< double > &rVariable, double &Output, const ProcessInfo &r_current_process_info) override
 
array_1d< double, 3 > ComputeWeight (const array_1d< double, 3 > &gravity, const ProcessInfo &r_process_info) override
 
void AddCentrifugalForces (array_1d< double, 3 > &weight, const ProcessInfo &r_process_info)
 
void AddCoriolisForces (array_1d< double, 3 > &weight, const ProcessInfo &r_process_info)
 
void AddRelativeAccelerationForces (array_1d< double, 3 > &weight, const ProcessInfo &r_process_info)
 
void AddEulerForces (array_1d< double, 3 > &weight, const ProcessInfo &r_process_info)
 
virtual double GetFluidMass ()
 

Serialization

class Serializer
 

Member Typedef Documentation

◆ GeometryType

template<class TBaseElement >
typedef Geometry<NodeType> Kratos::SwimmingParticle< TBaseElement >::GeometryType

◆ IndexType

template<class TBaseElement >
typedef std::size_t Kratos::SwimmingParticle< TBaseElement >::IndexType

◆ NodesArrayType

template<class TBaseElement >
typedef Geometry<NodeType>::PointsArrayType Kratos::SwimmingParticle< TBaseElement >::NodesArrayType

◆ NodeType

template<class TBaseElement >
typedef Node Kratos::SwimmingParticle< TBaseElement >::NodeType

◆ PropertiesType

template<class TBaseElement >
typedef Properties Kratos::SwimmingParticle< TBaseElement >::PropertiesType

Constructor & Destructor Documentation

◆ SwimmingParticle() [1/4]

template<class TBaseElement >
Kratos::SwimmingParticle< TBaseElement >::SwimmingParticle ( )
inline

Default constructor.

◆ SwimmingParticle() [2/4]

template<class TBaseElement >
Kratos::SwimmingParticle< TBaseElement >::SwimmingParticle ( IndexType  NewId,
GeometryType::Pointer  pGeometry 
)
inline

◆ SwimmingParticle() [3/4]

template<class TBaseElement >
Kratos::SwimmingParticle< TBaseElement >::SwimmingParticle ( IndexType  NewId,
NodesArrayType const &  ThisNodes 
)
inline

◆ SwimmingParticle() [4/4]

template<class TBaseElement >
Kratos::SwimmingParticle< TBaseElement >::SwimmingParticle ( IndexType  NewId,
GeometryType::Pointer  pGeometry,
PropertiesType::Pointer  pProperties 
)
inline

◆ ~SwimmingParticle()

template<class TBaseElement >
virtual Kratos::SwimmingParticle< TBaseElement >::~SwimmingParticle ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ AddCentrifugalForces()

template<class TBaseElement >
void Kratos::SwimmingParticle< TBaseElement >::AddCentrifugalForces ( array_1d< double, 3 > &  weight,
const ProcessInfo r_process_info 
)
protected

◆ AddCoriolisForces()

template<class TBaseElement >
void Kratos::SwimmingParticle< TBaseElement >::AddCoriolisForces ( array_1d< double, 3 > &  weight,
const ProcessInfo r_process_info 
)
protected

◆ AddEulerForces()

template<class TBaseElement >
void Kratos::SwimmingParticle< TBaseElement >::AddEulerForces ( array_1d< double, 3 > &  weight,
const ProcessInfo r_process_info 
)
protected

◆ AdditionalCalculate()

template<class TBaseElement >
void Kratos::SwimmingParticle< TBaseElement >::AdditionalCalculate ( const Variable< double > &  rVariable,
double Output,
const ProcessInfo r_current_process_info 
)
overrideprotected

◆ AddRelativeAccelerationForces()

template<class TBaseElement >
void Kratos::SwimmingParticle< TBaseElement >::AddRelativeAccelerationForces ( array_1d< double, 3 > &  weight,
const ProcessInfo r_process_info 
)
protected

◆ Calculate()

template<class TBaseElement >
void Kratos::SwimmingParticle< TBaseElement >::Calculate ( const Variable< array_1d< double, 3 > > &  rVariable,
array_1d< double, 3 > &  Output,
const ProcessInfo r_current_process_info 
)
override

◆ ComputeAdditionalForces()

template<class TBaseElement >
void Kratos::SwimmingParticle< TBaseElement >::ComputeAdditionalForces ( array_1d< double, 3 > &  additionally_applied_force,
array_1d< double, 3 > &  additionally_applied_moment,
const ProcessInfo rCurrentProcessInfo,
const array_1d< double, 3 > &  gravity 
)
override

◆ ComputeWeight()

template<class TBaseElement >
array_1d< double, 3 > Kratos::SwimmingParticle< TBaseElement >::ComputeWeight ( const array_1d< double, 3 > &  gravity,
const ProcessInfo r_process_info 
)
overrideprotected

◆ Create()

template<class TBaseElement >
Element::Pointer Kratos::SwimmingParticle< TBaseElement >::Create ( IndexType  NewId,
NodesArrayType const &  ThisNodes,
PropertiesType::Pointer  pProperties 
) const
inlineoverride

◆ CreateHydrodynamicInteractionLaws()

template<class TBaseElement >
void Kratos::SwimmingParticle< TBaseElement >::CreateHydrodynamicInteractionLaws ( const ProcessInfo r_process_info)
virtual

◆ GetFluidMass()

template<class TBaseElement >
double Kratos::SwimmingParticle< TBaseElement >::GetFluidMass
protectedvirtual

◆ Info()

template<class TBaseElement >
virtual std::string Kratos::SwimmingParticle< TBaseElement >::Info ( ) const
inlineoverridevirtual

Turn back information as a string.

◆ KRATOS_CLASS_INTRUSIVE_POINTER_DEFINITION()

template<class TBaseElement >
Kratos::SwimmingParticle< TBaseElement >::KRATOS_CLASS_INTRUSIVE_POINTER_DEFINITION ( SwimmingParticle< TBaseElement >  )

Pointer definition of SwimmingParticle.

◆ MemberDeclarationFirstStep()

template<class TBaseElement >
void Kratos::SwimmingParticle< TBaseElement >::MemberDeclarationFirstStep ( const ProcessInfo r_current_process_info)
overrideprotected

◆ operator=()

template<class TBaseElement >
SwimmingParticle< TBaseElement > & Kratos::SwimmingParticle< TBaseElement >::operator= ( const SwimmingParticle< TBaseElement > &  rOther)

◆ PrintData()

template<class TBaseElement >
virtual void Kratos::SwimmingParticle< TBaseElement >::PrintData ( std::ostream &  rOStream) const
inlineoverridevirtual

Print object's data.

◆ PrintInfo()

template<class TBaseElement >
virtual void Kratos::SwimmingParticle< TBaseElement >::PrintInfo ( std::ostream &  rOStream) const
inlineoverridevirtual

Print information about this object.

Friends And Related Function Documentation

◆ Serializer

template<class TBaseElement >
friend class Serializer
friend

Member Data Documentation

◆ mNeighbourNodes

template<class TBaseElement >
std::vector<Node::Pointer> Kratos::SwimmingParticle< TBaseElement >::mNeighbourNodes

◆ mNeighbourNodesDistances

template<class TBaseElement >
std::vector<double> Kratos::SwimmingParticle< TBaseElement >::mNeighbourNodesDistances

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