Kratos::CalculateWaveHeightUtility Class Reference

This function computes the wave height at a given point. More...

#include <calculate_wave_height_utility.h>

Collaboration diagram for Kratos::CalculateWaveHeightUtility:

Public Types
Type Definitions
typedef Node	NodeType
typedef Geometry< NodeType >	GeometryType

Public Member Functions
Pointer Definition
	KRATOS_CLASS_POINTER_DEFINITION (CalculateWaveHeightUtility)
Life Cycle
	CalculateWaveHeightUtility (ModelPart &rThisModelPart, Parameters ThisParameters)
	Constructor with ModelPart and Parameters. More...
	~CalculateWaveHeightUtility ()
	Destructor. More...
Operations
double	Calculate (const array_1d< double, 3 > &rCoordinates) const
	Calculate the wave height. More...
Input and output
std::string	Info () const
	Turn back information as a string. More...
void	PrintInfo (std::ostream &rOStream) const
	Print information about this object. More...
void	PrintData (std::ostream &rOStream) const
	Print information about this object. More...

Detailed Description

This function computes the wave height at a given point.

Author

Miguel Maso Sotomayor

The direction is taken from the gravity variable in the ProcessInfo

Member Typedef Documentation

GeometryType

typedef Geometry<NodeType> Kratos::CalculateWaveHeightUtility::GeometryType

NodeType

typedef Node Kratos::CalculateWaveHeightUtility::NodeType

Constructor & Destructor Documentation

CalculateWaveHeightUtility()

Kratos::CalculateWaveHeightUtility::CalculateWaveHeightUtility	(	ModelPart &	rThisModelPart,
		Parameters	ThisParameters
	)

Constructor with ModelPart and Parameters.

~CalculateWaveHeightUtility()

Kratos::CalculateWaveHeightUtility::~CalculateWaveHeightUtility ( )

inline

Destructor.

Member Function Documentation

Calculate()

double Kratos::CalculateWaveHeightUtility::Calculate

(

const array_1d< double, 3 > &

rCoordinates

)

const

Calculate the wave height.

Info()

std::string Kratos::CalculateWaveHeightUtility::Info ( ) const

inline

Turn back information as a string.

KRATOS_CLASS_POINTER_DEFINITION()

Kratos::CalculateWaveHeightUtility::KRATOS_CLASS_POINTER_DEFINITION

(

CalculateWaveHeightUtility

)

PrintData()

void Kratos::CalculateWaveHeightUtility::PrintData ( std::ostream &  rOStream ) const

inline

Print information about this object.

PrintInfo()

void Kratos::CalculateWaveHeightUtility::PrintInfo ( std::ostream &  rOStream ) const

inline

Print information about this object.

---

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

• /home/runner/work/Documentation/Documentation/master/applications/PfemFluidDynamicsApplication/custom_utilities/calculate_wave_height_utility.h
• /home/runner/work/Documentation/Documentation/master/applications/PfemFluidDynamicsApplication/custom_utilities/calculate_wave_height_utility.cpp