Implementation of a linear element for shallow water problems. More...

#include <boussinesq_element.h>

Inheritance diagram for Kratos::BoussinesqElement< TNumNodes >:

Collaboration diagram for Kratos::BoussinesqElement< TNumNodes >:

Public Types
Type Definitions
typedef std::size_t	IndexType

typedef Node	NodeType

typedef Geometry< NodeType >	GeometryType

typedef PrimitiveElement< TNumNodes >	BaseType

typedef BaseType::VectorType	VectorType

typedef BaseType::NodesArrayType	NodesArrayType

typedef BaseType::PropertiesType	PropertiesType

typedef BaseType::ElementData	ElementData

typedef BaseType::LocalMatrixType	LocalMatrixType

typedef BaseType::LocalVectorType	LocalVectorType

typedef BaseType::ShapeFunctionsGradientsType	ShapeFunctionsGradientsType

Public Types inherited from Kratos::PrimitiveElement< TNumNodes >
typedef std::size_t	IndexType

typedef Node	NodeType

typedef Geometry< NodeType >	GeometryType

typedef WaveElement< TNumNodes >	BaseType

typedef BaseType::NodesArrayType	NodesArrayType

typedef BaseType::PropertiesType	PropertiesType

typedef BaseType::ElementData	ElementData

typedef BaseType::LocalMatrixType	LocalMatrixType

typedef BaseType::LocalVectorType	LocalVectorType

typedef BaseType::ShapeFunctionsGradientsType	ShapeFunctionsGradientsType

Public Types inherited from Kratos::WaveElement< TNumNodes >
typedef std::size_t	IndexType

typedef Node	NodeType

typedef array_1d< double, 3 *TNumNodes >	LocalVectorType

typedef BoundedMatrix< double, 3 TNumNodes, 3 TNumNodes >	LocalMatrixType

typedef GeometryType::ShapeFunctionsGradientsType	ShapeFunctionsGradientsType

Public Types inherited from Kratos::Element
typedef Element	ElementType
	definition of element type More...

typedef GeometricalObject	BaseType
	base type: an GeometricalObject that automatically has a unique number More...

typedef Node	NodeType
	definition of node type (default is: Node) More...

typedef Properties	PropertiesType

typedef Geometry< NodeType >	GeometryType
	definition of the geometry type with given NodeType More...

typedef Geometry< NodeType >::PointsArrayType	NodesArrayType
	definition of nodes container type, redefined from GeometryType More...

typedef Vector	VectorType

typedef Matrix	MatrixType

typedef std::size_t	IndexType

typedef std::size_t	SizeType

typedef Dof< double >	DofType

typedef std::vector< std::size_t >	EquationIdVectorType

typedef std::vector< DofType::Pointer >	DofsVectorType

typedef PointerVectorSet< DofType >	DofsArrayType

typedef GeometryData::IntegrationMethod	IntegrationMethod
	Type definition for integration methods. More...

typedef GeometryData	GeometryDataType

Public Types inherited from Kratos::GeometricalObject
typedef Node	NodeType
	Definition of the node type. More...

typedef Geometry< NodeType >	GeometryType
	The geometry type definition. More...

typedef std::size_t	IndexType
	Defines the index type. More...

typedef std::size_t	result_type
	Defines the result type. More...

Public Types inherited from Kratos::IndexedObject
typedef std::size_t	IndexType
	The definition of the index type. More...

typedef std::size_t	result_type
	The definition of the result_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
Pointer definition
	KRATOS_CLASS_INTRUSIVE_POINTER_DEFINITION (BoussinesqElement)

Life Cycle
	BoussinesqElement ()
	Default constructor. More...

	BoussinesqElement (IndexType NewId, const NodesArrayType &ThisNodes)
	Constructor using an array of nodes. More...

	BoussinesqElement (IndexType NewId, GeometryType::Pointer pGeometry)
	Constructor using Geometry. More...

	BoussinesqElement (IndexType NewId, GeometryType::Pointer pGeometry, typename PropertiesType::Pointer pProperties)
	Constructor using Geometry and Properties. More...

	~ BoussinesqElement () override
	Destructor. More...

Operations
Element::Pointer	Create (IndexType NewId, NodesArrayType const &ThisNodes, typename PropertiesType::Pointer pProperties) const override
	Create a new element pointer. More...

Element::Pointer	Create (IndexType NewId, GeometryType::Pointer pGeom, typename PropertiesType::Pointer pProperties) const override
	Create a new element pointer. More...

Element::Pointer	Clone (IndexType NewId, NodesArrayType const &ThisNodes) const override
	Create a new element pointer and clone the previous element data. More...

void	InitializeNonLinearIteration (const ProcessInfo &rCurrentProcessInfo) override
	Calculate the velocity laplacian projection. More...

void	CalculateRightHandSide (VectorType &rRightHandSideVector, const ProcessInfo &rCurrentProcessInfo) override
	Calculate the rhs according to the Adams-Moulton scheme. More...

void	AddExplicitContribution (const ProcessInfo &rCurrentProcessInfo) override
	Add the explicit contribution according to the Adams-Bashforth scheme. More...

Inquiry
const Parameters	GetSpecifications () const override
	This method provides the specifications/requirements of the element. More...

Input and output
std::string	Info () const override
	Turn back information as a string. More...

Public Member Functions inherited from Kratos::PrimitiveElement< TNumNodes >
	KRATOS_CLASS_INTRUSIVE_POINTER_DEFINITION (PrimitiveElement)

	PrimitiveElement ()
	Default constructor. More...

	PrimitiveElement (IndexType NewId, const NodesArrayType &ThisNodes)
	Constructor using an array of nodes. More...

	PrimitiveElement (IndexType NewId, GeometryType::Pointer pGeometry)
	Constructor using Geometry. More...

	PrimitiveElement (IndexType NewId, GeometryType::Pointer pGeometry, typename PropertiesType::Pointer pProperties)
	Constructor using Geometry and Properties. More...

	~ PrimitiveElement () override
	Destructor. More...

Element::Pointer	Create (IndexType NewId, NodesArrayType const &ThisNodes, typename PropertiesType::Pointer pProperties) const override
	Create a new element pointer. More...

Element::Pointer	Create (IndexType NewId, GeometryType::Pointer pGeom, typename PropertiesType::Pointer pProperties) const override
	Create a new element pointer. More...

Element::Pointer	Clone (IndexType NewId, NodesArrayType const &ThisNodes) const override
	Create a new element pointer and clone the previous element data. More...

std::string	Info () const override
	Turn back information as a string. More...

Public Member Functions inherited from Kratos::WaveElement< TNumNodes >
GeometryData::IntegrationMethod	GetIntegrationMethod () const

GeometryData::IntegrationMethod	GetIntegrationMethod () const

GeometryData::IntegrationMethod	GetIntegrationMethod () const

GeometryData::IntegrationMethod	GetIntegrationMethod () const

GeometryData::IntegrationMethod	GetIntegrationMethod () const

	WaveElement ()
	Default constructor. More...

	WaveElement (IndexType NewId, const NodesArrayType &ThisNodes)
	Constructor using an array of nodes. More...

	WaveElement (IndexType NewId, GeometryType::Pointer pGeometry)
	Constructor using Geometry. More...

	WaveElement (IndexType NewId, GeometryType::Pointer pGeometry, PropertiesType::Pointer pProperties)
	Constructor using Geometry and Properties. More...

	~ WaveElement () override
	Destructor. More...

Element::Pointer	Create (IndexType NewId, NodesArrayType const &ThisNodes, PropertiesType::Pointer pProperties) const override
	Create a new element pointer. More...

Element::Pointer	Create (IndexType NewId, GeometryType::Pointer pGeom, PropertiesType::Pointer pProperties) const override
	Create a new element pointer. More...

Element::Pointer	Clone (IndexType NewId, NodesArrayType const &ThisNodes) const override
	Create a new element pointer and clone the previous element data. More...

int	Check (const ProcessInfo &rCurrentProcessInfo) const override
	Check that all required data containers are properly initialized and registered in Kratos. More...

void	EquationIdVector (EquationIdVectorType &rResult, const ProcessInfo &rCurrentProcessInfo) const override
	Fill given vector with the linear system row index for the element's degrees of freedom. More...

void	GetDofList (DofsVectorType &rElementalDofList, const ProcessInfo &rCurrentProcessInfo) const override
	Fill given array with containing the element's degrees of freedom. More...

void	GetValuesVector (Vector &rValues, int Step=0) const override
	Get the variable which defines the degrees of freedom. More...

void	GetFirstDerivativesVector (Vector &rValues, int Step=0) const override
	Get the time derivative of variable which defines the degrees of freedom. More...

void	GetSecondDerivativesVector (Vector &rValues, int Step=0) const override
	Get the second time derivative of variable which defines the degrees of freedom. More...

void	CalculateOnIntegrationPoints (const Variable< double > &rVariable, std::vector< double > &rValues, const ProcessInfo &rCurrentProcessInfo) override
	Access for variables on Integration points. More...

void	Calculate (const Variable< array_1d< double, 3 >> &rVariable, array_1d< double, 3 > &rOutput, const ProcessInfo &rCurrentProcessInfo) override
	Access for variables on Integration points. More...

void	InitializeSolutionStep (const ProcessInfo &rCurrentProcessInfo) override
	Is called in the beginning of each solution step. More...

void	CalculateLocalSystem (MatrixType &rLeftHandSideMatrix, VectorType &rRightHandSideVector, const ProcessInfo &rCurrentProcessInfo) override
	Calculate the elemental contribution to the problem. More...

void	CalculateMassMatrix (MatrixType &rMassMatrix, const ProcessInfo &rCurrentProcessInfo) override
	Calculate the elemental mass matrix. More...

void	CalculateDampingMatrix (MatrixType &rDampingMatrix, const ProcessInfo &rCurrentProcessInfo) override
	Calculate the diffusion matrix for monotonic corrected schemes. More...

GeometryData::IntegrationMethod	GetIntegrationMethod () const override
	GetIntegrationMethod Return the integration order to be used. More...

const Parameters	GetSpecifications () const override
	This method provides the specifications/requirements of the element. 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...

	KRATOS_CLASS_INTRUSIVE_POINTER_DEFINITION (WaveElement)
	Pointer definition. More...

Public Member Functions inherited from Kratos::Element
	Element (IndexType NewId=0)

	Element (IndexType NewId, const NodesArrayType &ThisNodes)

	Element (IndexType NewId, GeometryType::Pointer pGeometry)

	Element (IndexType NewId, GeometryType::Pointer pGeometry, PropertiesType::Pointer pProperties)

	Element (Element const &rOther)
	Copy constructor. More...

	~Element () override
	Destructor. More...

Element &	operator= (Element const &rOther)
	Assignment operator. More...

virtual void	Initialize (const ProcessInfo &rCurrentProcessInfo)

virtual void	ResetConstitutiveLaw ()

virtual void	FinalizeNonLinearIteration (const ProcessInfo &rCurrentProcessInfo)

virtual void	FinalizeSolutionStep (const ProcessInfo &rCurrentProcessInfo)

virtual void	CalculateLeftHandSide (MatrixType &rLeftHandSideMatrix, const ProcessInfo &rCurrentProcessInfo)

virtual void	CalculateFirstDerivativesContributions (MatrixType &rLeftHandSideMatrix, VectorType &rRightHandSideVector, const ProcessInfo &rCurrentProcessInfo)

virtual void	CalculateFirstDerivativesLHS (MatrixType &rLeftHandSideMatrix, const ProcessInfo &rCurrentProcessInfo)

virtual void	CalculateFirstDerivativesRHS (VectorType &rRightHandSideVector, const ProcessInfo &rCurrentProcessInfo)

virtual void	CalculateSecondDerivativesContributions (MatrixType &rLeftHandSideMatrix, VectorType &rRightHandSideVector, const ProcessInfo &rCurrentProcessInfo)

virtual void	CalculateSecondDerivativesLHS (MatrixType &rLeftHandSideMatrix, const ProcessInfo &rCurrentProcessInfo)

virtual void	CalculateSecondDerivativesRHS (VectorType &rRightHandSideVector, const ProcessInfo &rCurrentProcessInfo)

virtual void	CalculateLumpedMassVector (VectorType &rLumpedMassVector, const ProcessInfo &rCurrentProcessInfo) const

virtual void	AddExplicitContribution (const VectorType &rRHSVector, const Variable< VectorType > &rRHSVariable, const Variable< double > &rDestinationVariable, const ProcessInfo &rCurrentProcessInfo)
	This function is designed to make the element to assemble an rRHS vector identified by a variable rRHSVariable by assembling it to the nodes on the variable rDestinationVariable. (This is the double version) More...

virtual void	AddExplicitContribution (const VectorType &rRHSVector, const Variable< VectorType > &rRHSVariable, const Variable< array_1d< double, 3 > > &rDestinationVariable, const ProcessInfo &rCurrentProcessInfo)
	This function is designed to make the element to assemble an rRHS vector identified by a variable rRHSVariable by assembling it to the nodes on the variable rDestinationVariable. (This is the vector version) More...

virtual void	AddExplicitContribution (const MatrixType &rLHSMatrix, const Variable< MatrixType > &rLHSVariable, const Variable< Matrix > &rDestinationVariable, const ProcessInfo &rCurrentProcessInfo)
	This function is designed to make the element to assemble an rRHS vector identified by a variable rRHSVariable by assembling it to the nodes on the variable rDestinationVariable. (This is the matrix version) More...

virtual void	Calculate (const Variable< double > &rVariable, double &Output, const ProcessInfo &rCurrentProcessInfo)

virtual void	Calculate (const Variable< array_1d< double, 3 > > &rVariable, array_1d< double, 3 > &Output, const ProcessInfo &rCurrentProcessInfo)

virtual void	Calculate (const Variable< Vector > &rVariable, Vector &Output, const ProcessInfo &rCurrentProcessInfo)

virtual void	Calculate (const Variable< Matrix > &rVariable, Matrix &Output, const ProcessInfo &rCurrentProcessInfo)

virtual void	CalculateOnIntegrationPoints (const Variable< bool > &rVariable, std::vector< bool > &rOutput, const ProcessInfo &rCurrentProcessInfo)

virtual void	CalculateOnIntegrationPoints (const Variable< int > &rVariable, std::vector< int > &rOutput, const ProcessInfo &rCurrentProcessInfo)

virtual void	CalculateOnIntegrationPoints (const Variable< array_1d< double, 3 >> &rVariable, std::vector< array_1d< double, 3 >> &rOutput, const ProcessInfo &rCurrentProcessInfo)

virtual void	CalculateOnIntegrationPoints (const Variable< array_1d< double, 4 >> &rVariable, std::vector< array_1d< double, 4 >> &rOutput, const ProcessInfo &rCurrentProcessInfo)

virtual void	CalculateOnIntegrationPoints (const Variable< array_1d< double, 6 >> &rVariable, std::vector< array_1d< double, 6 >> &rOutput, const ProcessInfo &rCurrentProcessInfo)

virtual void	CalculateOnIntegrationPoints (const Variable< array_1d< double, 9 >> &rVariable, std::vector< array_1d< double, 9 >> &rOutput, const ProcessInfo &rCurrentProcessInfo)

virtual void	CalculateOnIntegrationPoints (const Variable< Vector > &rVariable, std::vector< Vector > &rOutput, const ProcessInfo &rCurrentProcessInfo)

virtual void	CalculateOnIntegrationPoints (const Variable< Matrix > &rVariable, std::vector< Matrix > &rOutput, const ProcessInfo &rCurrentProcessInfo)

virtual void	CalculateOnIntegrationPoints (const Variable< ConstitutiveLaw::Pointer > &rVariable, std::vector< ConstitutiveLaw::Pointer > &rOutput, const ProcessInfo &rCurrentProcessInfo)

virtual void	SetValuesOnIntegrationPoints (const Variable< bool > &rVariable, const std::vector< bool > &rValues, const ProcessInfo &rCurrentProcessInfo)

virtual void	SetValuesOnIntegrationPoints (const Variable< int > &rVariable, const std::vector< int > &rValues, const ProcessInfo &rCurrentProcessInfo)

virtual void	SetValuesOnIntegrationPoints (const Variable< double > &rVariable, const std::vector< double > &rValues, const ProcessInfo &rCurrentProcessInfo)

virtual void	SetValuesOnIntegrationPoints (const Variable< array_1d< double, 3 >> &rVariable, const std::vector< array_1d< double, 3 >> &rValues, const ProcessInfo &rCurrentProcessInfo)

virtual void	SetValuesOnIntegrationPoints (const Variable< array_1d< double, 4 >> &rVariable, const std::vector< array_1d< double, 4 >> &rValues, const ProcessInfo &rCurrentProcessInfo)

virtual void	SetValuesOnIntegrationPoints (const Variable< array_1d< double, 6 >> &rVariable, const std::vector< array_1d< double, 6 >> &rValues, const ProcessInfo &rCurrentProcessInfo)

virtual void	SetValuesOnIntegrationPoints (const Variable< array_1d< double, 9 >> &rVariable, const std::vector< array_1d< double, 9 >> &rValues, const ProcessInfo &rCurrentProcessInfo)

virtual void	SetValuesOnIntegrationPoints (const Variable< Vector > &rVariable, const std::vector< Vector > &rValues, const ProcessInfo &rCurrentProcessInfo)

virtual void	SetValuesOnIntegrationPoints (const Variable< Matrix > &rVariable, const std::vector< Matrix > &rValues, const ProcessInfo &rCurrentProcessInfo)

virtual void	SetValuesOnIntegrationPoints (const Variable< ConstitutiveLaw::Pointer > &rVariable, const std::vector< ConstitutiveLaw::Pointer > &rValues, const ProcessInfo &rCurrentProcessInfo)

virtual void	MassMatrix (MatrixType &rMassMatrix, const ProcessInfo &rCurrentProcessInfo)

virtual void	AddMassMatrix (MatrixType &rLeftHandSideMatrix, double coeff, const ProcessInfo &rCurrentProcessInfo)

virtual void	DampMatrix (MatrixType &rDampMatrix, const ProcessInfo &rCurrentProcessInfo)

virtual void	AddInertiaForces (VectorType &rRightHandSideVector, double coeff, const ProcessInfo &rCurrentProcessInfo)

virtual void	CalculateLocalVelocityContribution (MatrixType &rDampingMatrix, VectorType &rRightHandSideVector, const ProcessInfo &rCurrentProcessInfo)

virtual void	CalculateSensitivityMatrix (const Variable< double > &rDesignVariable, Matrix &rOutput, const ProcessInfo &rCurrentProcessInfo)

virtual void	CalculateSensitivityMatrix (const Variable< array_1d< double, 3 > > &rDesignVariable, Matrix &rOutput, const ProcessInfo &rCurrentProcessInfo)

PropertiesType::Pointer	pGetProperties ()
	returns the pointer to the property of the element. Does not throw an error, to allow copying of elements which don't have any property assigned. More...

const PropertiesType::Pointer	pGetProperties () const

PropertiesType &	GetProperties ()

PropertiesType const &	GetProperties () const

void	SetProperties (PropertiesType::Pointer pProperties)

bool	HasProperties () const
	Check that the Element has a correctly initialized pointer to a Properties instance. More...

	KRATOS_CLASS_INTRUSIVE_POINTER_DEFINITION (Element)

Public Member Functions inherited from Kratos::GeometricalObject
	GeometricalObject (IndexType NewId=0)
	Default constructor. More...

	GeometricalObject (IndexType NewId, GeometryType::Pointer pGeometry)
	Default constructor. More...

	~GeometricalObject () override
	Destructor. More...

	GeometricalObject (GeometricalObject const &rOther)
	Copy constructor. More...

GeometricalObject &	operator= (GeometricalObject const &rOther)
	Assignment operator. More...

virtual void	SetGeometry (GeometryType::Pointer pGeometry)
	Sets the pointer to the geometry. More...

GeometryType::Pointer	pGetGeometry ()
	Returns the pointer to the geometry. More...

const GeometryType::Pointer	pGetGeometry () const
	Returns the pointer to the geometry (const version) More...

GeometryType &	GetGeometry ()
	Returns the reference of the geometry. More...

GeometryType const &	GetGeometry () const
	Returns the reference of the geometry (const version) More...

Flags &	GetFlags ()
	Returns the flags of the object. More...

Flags const &	GetFlags () const
	Returns the flags of the object (const version) More...

void	SetFlags (Flags const &rThisFlags)
	Sets the flags of the object. More...

DataValueContainer &	Data ()

DataValueContainer &	GetData ()

DataValueContainer const &	GetData () const

void	SetData (DataValueContainer const &rThisData)

template<class TDataType >
bool	Has (const Variable< TDataType > &rThisVariable) const

template<class TVariableType >
void	SetValue (const TVariableType &rThisVariable, typename TVariableType::Type const &rValue)

template<class TVariableType >
TVariableType::Type &	GetValue (const TVariableType &rThisVariable)

template<class TVariableType >
TVariableType::Type const &	GetValue (const TVariableType &rThisVariable) const

unsigned int	use_count () const noexcept

	KRATOS_CLASS_INTRUSIVE_POINTER_DEFINITION (GeometricalObject)
	Pointer definition of GeometricalObject. More...

bool	IsActive () const
	Checks if the GeometricalObject is active. More...

Public Member Functions inherited from Kratos::IndexedObject
	IndexedObject (IndexType NewId=0)
	Default constructor. More...

virtual	~IndexedObject ()
	Destructor. More...

	IndexedObject (IndexedObject const &rOther)
	Copy constructor. More...

IndexedObject &	operator= (IndexedObject const &rOther)
	Assignment operator. More...

template<class TObjectType >
IndexType	operator() (TObjectType const &rThisObject) const

IndexType	Id () const

IndexType	GetId () const

virtual void	SetId (IndexType NewId)

IndexType &	DepricatedIdAccess ()
	TODO: remove this function when removing data_file_io object. More...

	KRATOS_CLASS_POINTER_DEFINITION (IndexedObject)
	Pointer definition of IndexedObject. More...

Public Member Functions inherited from Kratos::Flags
Flags &	operator= (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 Flags &	operator\|= (const Flags &Other)

const Flags &	operator&= (const Flags &Other)

	Flags ()
	Default constructor. More...

	Flags (Flags const &rOther)
	Copy constructor. More...

virtual	~Flags ()
	Destructor. More...

Protected Member Functions
Protected Operations
void	AddRightHandSide (LocalVectorType &rRHS, ElementData &rData, const Matrix &rNContainer, const ShapeFunctionsGradientsType &rDN_DXContainer, const Vector &rWeights)

void	AddDispersionProjection (LocalVectorType &rDispersionH, LocalVectorType &rDispersionU, const ElementData &rData, const array_1d< double, TNumNodes > &rN, const BoundedMatrix< double, TNumNodes, 2 > &rDN_DX, const double Weight=1.0)

void	GetNodalData (ElementData &rData, const GeometryType &rGeometry, int Step=0) override

void	CalculateArtificialViscosity (BoundedMatrix< double, 3, 3 > &rViscosity, BoundedMatrix< double, 2, 2 > &rDiffusion, const ElementData &rData, const array_1d< double, TNumNodes > &rN, const BoundedMatrix< double, TNumNodes, 2 > &rDN_DX) override

void	AlgebraicResidual (double &rMassResidual, array_1d< double, 2 > &rFreeSurfaceGradient, const ElementData &rData, const array_1d< double, TNumNodes > &rN, const BoundedMatrix< double, TNumNodes, 2 > &rDN_DX) const

void	AddDispersiveTerms (LocalVectorType &rVector, const ElementData &rData, const array_1d< double, TNumNodes > &rN, const BoundedMatrix< double, TNumNodes, 2 > &rDN_DX, const double Weight=1.0) override

void	AddMassTerms (LocalMatrixType &rMatrix, const ElementData &rData, const array_1d< double, TNumNodes > &rN, const BoundedMatrix< double, TNumNodes, 2 > &rDN_DX, const double Weight=1.0) override

Protected Member Functions inherited from Kratos::PrimitiveElement< TNumNodes >
void	UpdateGaussPointData (ElementData &rData, const array_1d< double, TNumNodes > &rN) override

double	StabilizationParameter (const ElementData &rData) const override

Protected Member Functions inherited from Kratos::WaveElement< TNumNodes >
virtual const Variable< double > &	GetUnknownComponent (int Index) const

virtual LocalVectorType	GetUnknownVector (const ElementData &rData) const

virtual void	InitializeData (ElementData &rData, const ProcessInfo &rCurrentProcessInfo)

virtual void	GetNodalData (ElementData &rData, const GeometryType &rGeometry, int Step=0)

virtual void	UpdateGaussPointData (ElementData &rData, const array_1d< double, TNumNodes > &rN)

void	CalculateGeometryData (const GeometryType &rGeometry, Vector &rGaussWeights, Matrix &rNContainer, ShapeFunctionsGradientsType &rDN_DX)

virtual void	CalculateArtificialViscosity (BoundedMatrix< double, 3, 3 > &rViscosity, BoundedMatrix< double, 2, 2 > &rDiffusion, const ElementData &rData, const array_1d< double, TNumNodes > &rN, const BoundedMatrix< double, TNumNodes, 2 > &rDN_DX)

virtual void	CalculateArtificialDamping (BoundedMatrix< double, 3, 3 > &rDamping, const ElementData &rData)

void	AddWaveTerms (LocalMatrixType &rMatrix, LocalVectorType &rVector, const ElementData &rData, const array_1d< double, TNumNodes > &rN, const BoundedMatrix< double, TNumNodes, 2 > &rDN_DX, const double Weight=1.0)

void	AddFrictionTerms (LocalMatrixType &rMatrix, LocalVectorType &rVector, const ElementData &rData, const array_1d< double, TNumNodes > &rN, const BoundedMatrix< double, TNumNodes, 2 > &rDN_DX, const double Weight=1.0)

void	AddArtificialViscosityTerms (LocalMatrixType &rMatrix, LocalVectorType &rVector, const ElementData &rData, const array_1d< double, TNumNodes > &rN, const BoundedMatrix< double, TNumNodes, 2 > &rDN_DX, const double Weight=1.0)

virtual void	AddDispersiveTerms (LocalVectorType &rVector, const ElementData &rData, const array_1d< double, TNumNodes > &rN, const BoundedMatrix< double, TNumNodes, 2 > &rDN_DX, const double Weight=1.0)

virtual void	AddMassTerms (LocalMatrixType &rMatrix, const ElementData &rData, const array_1d< double, TNumNodes > &rN, const BoundedMatrix< double, TNumNodes, 2 > &rDN_DX, const double Weight=1.0)

virtual double	StabilizationParameter (const ElementData &rData) const

Static Protected Attributes
Protected static Member Variables
static constexpr IndexType	mLocalSize = BaseType::mLocalSize

Static Protected Attributes inherited from Kratos::PrimitiveElement< TNumNodes >
static constexpr IndexType	mLocalSize = BaseType::mLocalSize

Static Protected Attributes inherited from Kratos::WaveElement< TNumNodes >
static constexpr IndexType	mLocalSize = 3 * TNumNodes

Serialization
class	Serializer

Additional Inherited Members
Static Public Member Functions inherited from Kratos::GeometricalObject
static bool	HasSameType (const GeometricalObject &rLHS, const GeometricalObject &rRHS)
	Checks if two GeometricalObject have the same type. More...

static bool	HasSameType (const GeometricalObject rLHS, const GeometricalObject rRHS)
	Checks if two GeometricalObject have the same type (pointer version) More...

static bool	HasSameGeometryType (const GeometricalObject &rLHS, const GeometricalObject &rRHS)
	Checks if two GeometricalObject have the same geometry type. More...

static bool	HasSameGeometryType (const GeometricalObject rLHS, const GeometricalObject rRHS)
	Checks if two GeometricalObject have the same geometry type (pointer version) More...

static bool	IsSame (const GeometricalObject &rLHS, const GeometricalObject &rRHS)
	Checks if two GeometricalObject are the same. More...

static bool	IsSame (const GeometricalObject rLHS, const GeometricalObject rRHS)
	Checks if two GeometricalObject are the same (pointer version) More...

Static Public Member Functions inherited from Kratos::Flags
static const Flags	AllDefined ()

static const Flags	AllTrue ()

static Flags	Create (IndexType ThisPosition, bool Value=true)

Static Protected Member Functions inherited from Kratos::WaveElement< TNumNodes >
static double	ShapeFunctionProduct (const array_1d< double, TNumNodes > &rN, const std::size_t I, const std::size_t J)

static array_1d< double, 3 >	VectorProduct (const array_1d< array_1d< double, 3 >, TNumNodes > &rV, const array_1d< double, TNumNodes > &rN)

static array_1d< double, 3 >	ScalarGradient (const array_1d< double, TNumNodes > &rS, const BoundedMatrix< double, TNumNodes, 2 > &rDN_DX)

static double	VectorDivergence (const array_1d< array_1d< double, 3 >, TNumNodes > &rV, const BoundedMatrix< double, TNumNodes, 2 > &rDN_DX)

static BoundedMatrix< double, 3, 3 >	VectorGradient (const array_1d< array_1d< double, 3 >, TNumNodes > &rV, const BoundedMatrix< double, TNumNodes, 2 > &rDN_DX)

static double	InverseHeight (const ElementData &rData)

static double	WetFraction (const ElementData &rData)

Detailed Description

template<std::size_t TNumNodes>
class Kratos::BoussinesqElement< TNumNodes >

Implementation of a linear element for shallow water problems.

Member Typedef Documentation

◆ BaseType

template<std::size_t TNumNodes>

typedef PrimitiveElement<TNumNodes> Kratos::BoussinesqElement< TNumNodes >::BaseType

◆ ElementData

template<std::size_t TNumNodes>

typedef BaseType::ElementData Kratos::BoussinesqElement< TNumNodes >::ElementData

◆ GeometryType

template<std::size_t TNumNodes>

typedef Geometry<NodeType> Kratos::BoussinesqElement< TNumNodes >::GeometryType

◆ IndexType

template<std::size_t TNumNodes>

typedef std::size_t Kratos::BoussinesqElement< TNumNodes >::IndexType

◆ LocalMatrixType

template<std::size_t TNumNodes>

typedef BaseType::LocalMatrixType Kratos::BoussinesqElement< TNumNodes >::LocalMatrixType

◆ LocalVectorType

template<std::size_t TNumNodes>

typedef BaseType::LocalVectorType Kratos::BoussinesqElement< TNumNodes >::LocalVectorType

◆ NodesArrayType

template<std::size_t TNumNodes>

typedef BaseType::NodesArrayType Kratos::BoussinesqElement< TNumNodes >::NodesArrayType

◆ NodeType

template<std::size_t TNumNodes>

typedef Node Kratos::BoussinesqElement< TNumNodes >::NodeType

◆ PropertiesType

template<std::size_t TNumNodes>

typedef BaseType::PropertiesType Kratos::BoussinesqElement< TNumNodes >::PropertiesType

◆ ShapeFunctionsGradientsType

template<std::size_t TNumNodes>

typedef BaseType::ShapeFunctionsGradientsType Kratos::BoussinesqElement< TNumNodes >::ShapeFunctionsGradientsType

◆ VectorType

template<std::size_t TNumNodes>

typedef BaseType::VectorType Kratos::BoussinesqElement< TNumNodes >::VectorType

Constructor & Destructor Documentation

◆ BoussinesqElement() [1/4]

template<std::size_t TNumNodes>

Kratos::BoussinesqElement< TNumNodes >::BoussinesqElement ( )

inline

Default constructor.

◆ BoussinesqElement() [2/4]

template<std::size_t TNumNodes>

Kratos::BoussinesqElement< TNumNodes >::BoussinesqElement	(	IndexType	NewId,
		const NodesArrayType &	ThisNodes
	)

inline

Constructor using an array of nodes.

◆ BoussinesqElement() [3/4]

template<std::size_t TNumNodes>

Kratos::BoussinesqElement< TNumNodes >::BoussinesqElement	(	IndexType	NewId,
		GeometryType::Pointer	pGeometry
	)

inline

Constructor using Geometry.

◆ BoussinesqElement() [4/4]

template<std::size_t TNumNodes>

Kratos::BoussinesqElement< TNumNodes >::BoussinesqElement	(	IndexType	NewId,
		GeometryType::Pointer	pGeometry,
		typename PropertiesType::Pointer	pProperties
	)

inline

Constructor using Geometry and Properties.

◆ ~ BoussinesqElement()

template<std::size_t TNumNodes>

Kratos::BoussinesqElement< TNumNodes >::~ BoussinesqElement ( )

inlineoverride

Destructor.

Member Function Documentation

◆ AddDispersionProjection()

template<std::size_t TNumNodes>

void Kratos::BoussinesqElement< TNumNodes >::AddDispersionProjection	(	LocalVectorType &	rDispersionH,
		LocalVectorType &	rDispersionU,
		const ElementData &	rData,
		const array_1d< double, TNumNodes > &	rN,
		const BoundedMatrix< double, TNumNodes, 2 > &	rDN_DX,
		const double	Weight = `1.0`
	)

protected

◆ AddDispersiveTerms()

template<std::size_t TNumNodes>

void Kratos::BoussinesqElement< TNumNodes >::AddDispersiveTerms	(	LocalVectorType &	rVector,
		const ElementData &	rData,
		const array_1d< double, TNumNodes > &	rN,
		const BoundedMatrix< double, TNumNodes, 2 > &	rDN_DX,
		const double	Weight = `1.0`
	)

overrideprotected

Gradient dispersion contribution to mass conservation

Stabilization x-x

Stabilization y-y

Stabilization x-y

Stabilization y-x

◆ AddExplicitContribution()

template<std::size_t TNumNodes>

void Kratos::BoussinesqElement< TNumNodes >::AddExplicitContribution ( const ProcessInfo & rCurrentProcessInfo )

overridevirtual

Add the explicit contribution according to the Adams-Bashforth scheme.

Parameters

rCurrentProcessInfo the current process info instance

Reimplemented from Kratos::Element.

◆ AddMassTerms()

template<std::size_t TNumNodes>

void Kratos::BoussinesqElement< TNumNodes >::AddMassTerms	(	LocalMatrixType &	rMatrix,
		const ElementData &	rData,
		const array_1d< double, TNumNodes > &	rN,
		const BoundedMatrix< double, TNumNodes, 2 > &	rDN_DX,
		const double	Weight = `1.0`
	)

overrideprotected

Consistent mass matrix

Stabilization x

Stabilization y

Dispersive term

◆ AddRightHandSide()

template<std::size_t TNumNodes>

void Kratos::BoussinesqElement< TNumNodes >::AddRightHandSide	(	LocalVectorType &	rRHS,
		ElementData &	rData,
		const Matrix &	rNContainer,
		const ShapeFunctionsGradientsType &	rDN_DXContainer,
		const Vector &	rWeights
	)

protected

Lumped mass matrix

◆ AlgebraicResidual()

template<std::size_t TNumNodes>

void Kratos::BoussinesqElement< TNumNodes >::AlgebraicResidual	(	double &	rMassResidual,
		array_1d< double, 2 > &	rFreeSurfaceGradient,
		const ElementData &	rData,
		const array_1d< double, TNumNodes > &	rN,
		const BoundedMatrix< double, TNumNodes, 2 > &	rDN_DX
	)		const

protected

◆ CalculateArtificialViscosity()

template<std::size_t TNumNodes>

void Kratos::BoussinesqElement< TNumNodes >::CalculateArtificialViscosity	(	BoundedMatrix< double, 3, 3 > &	rViscosity,
		BoundedMatrix< double, 2, 2 > &	rDiffusion,
		const ElementData &	rData,
		const array_1d< double, TNumNodes > &	rN,
		const BoundedMatrix< double, TNumNodes, 2 > &	rDN_DX
	)

overrideprotected

◆ CalculateRightHandSide()

template<std::size_t TNumNodes>

void Kratos::BoussinesqElement< TNumNodes >::CalculateRightHandSide	(	VectorType &	rRightHandSideVector,
		const ProcessInfo &	rCurrentProcessInfo
	)

overridevirtual

Calculate the rhs according to the Adams-Moulton scheme.

Parameters

rRightHandSideVector	Elemental right hand side vector
rCurrentProcessInfo	Reference to the ProcessInfo from the ModelPart containing the element

See also: ResidualBasedAdamsMoultonScheme

Reimplemented from Kratos::Element.

◆ Clone()

template<std::size_t TNumNodes>

Element::Pointer Kratos::BoussinesqElement< TNumNodes >::Clone	(	IndexType	NewId,
		NodesArrayType const &	ThisNodes
	)		const

inlineoverridevirtual

Create a new element pointer and clone the previous element data.

Parameters

NewId	the ID of the new element
rThisNodes	the nodes of the new element

Returns: a Pointer to the new element

Reimplemented from Kratos::Element.

◆ Create() [1/2]

template<std::size_t TNumNodes>

Element::Pointer Kratos::BoussinesqElement< TNumNodes >::Create	(	IndexType	NewId,
		GeometryType::Pointer	pGeom,
		typename PropertiesType::Pointer	pProperties
	)		const

inlineoverridevirtual

Create a new element pointer.

Parameters

NewId	the ID of the new element
pGeom	the geometry to be employed
pProperties	the properties assigned to the new element

Returns: a Pointer to the new element

Reimplemented from Kratos::Element.

◆ Create() [2/2]

template<std::size_t TNumNodes>

Element::Pointer Kratos::BoussinesqElement< TNumNodes >::Create	(	IndexType	NewId,
		NodesArrayType const &	ThisNodes,
		typename PropertiesType::Pointer	pProperties
	)		const

inlineoverridevirtual

Create a new element pointer.

Parameters

NewId	the ID of the new element
ThisNodes	the nodes of the new element
pProperties	the properties assigned to the new element

Returns: a Pointer to the new element

Reimplemented from Kratos::Element.

◆ GetNodalData()

template<std::size_t TNumNodes>

void Kratos::BoussinesqElement< TNumNodes >::GetNodalData	(	ElementData &	rData,
		const GeometryType &	rGeometry,
		int	Step = `0`
	)

overrideprotected

◆ GetSpecifications()

template<std::size_t TNumNodes>

const Parameters Kratos::BoussinesqElement< TNumNodes >::GetSpecifications

overridevirtual

This method provides the specifications/requirements of the element.

Returns: specifications The required specifications/requirements

Reimplemented from Kratos::Element.

◆ Info()

template<std::size_t TNumNodes>

std::string Kratos::BoussinesqElement< TNumNodes >::Info ( ) const

inlineoverridevirtual

Turn back information as a string.

Reimplemented from Kratos::Element.

◆ InitializeNonLinearIteration()

template<std::size_t TNumNodes>

void Kratos::BoussinesqElement< TNumNodes >::InitializeNonLinearIteration ( const ProcessInfo & rCurrentProcessInfo )

overridevirtual

Calculate the velocity laplacian projection.

Parameters

rCurrentProcessInfo Reference to the ProcessInfo from the ModelPart containing the elements

Reimplemented from Kratos::Element.

◆ KRATOS_CLASS_INTRUSIVE_POINTER_DEFINITION()

template<std::size_t TNumNodes>

Kratos::BoussinesqElement< TNumNodes >::KRATOS_CLASS_INTRUSIVE_POINTER_DEFINITION ( BoussinesqElement< TNumNodes > )

Friends And Related Function Documentation

◆ Serializer

template<std::size_t TNumNodes>

friend class Serializer

friend

Member Data Documentation

◆ mLocalSize

template<std::size_t TNumNodes>

constexpr IndexType Kratos::BoussinesqElement< TNumNodes >::mLocalSize = BaseType::mLocalSize

staticconstexprprotected

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

/home/runner/work/Documentation/Documentation/master/applications/ShallowWaterApplication/custom_elements/boussinesq_element.h
/home/runner/work/Documentation/Documentation/master/applications/ShallowWaterApplication/custom_elements/boussinesq_element.cpp

Public Types

Public Member Functions

Protected Member Functions

Static Protected Attributes

Serialization

Additional Inherited Members

Detailed Description

template<std::size_t TNumNodes> class Kratos::BoussinesqElement< TNumNodes >

Member Typedef Documentation

◆ BaseType

◆ ElementData

◆ GeometryType

◆ IndexType

◆ LocalMatrixType

◆ LocalVectorType

◆ NodesArrayType

◆ NodeType

◆ PropertiesType

◆ ShapeFunctionsGradientsType

◆ VectorType

Constructor & Destructor Documentation

◆ BoussinesqElement() [1/4]

◆ BoussinesqElement() [2/4]

◆ BoussinesqElement() [3/4]

◆ BoussinesqElement() [4/4]

◆ ~ BoussinesqElement()

Member Function Documentation

◆ AddDispersionProjection()

◆ AddDispersiveTerms()

◆ AddExplicitContribution()

◆ AddMassTerms()

◆ AddRightHandSide()

◆ AlgebraicResidual()

◆ CalculateArtificialViscosity()

◆ CalculateRightHandSide()

◆ Clone()

◆ Create() [1/2]

◆ Create() [2/2]

◆ GetNodalData()

◆ GetSpecifications()

◆ Info()

◆ InitializeNonLinearIteration()

◆ KRATOS_CLASS_INTRUSIVE_POINTER_DEFINITION()

Friends And Related Function Documentation

◆ Serializer

Member Data Documentation

◆ mLocalSize

template<std::size_t TNumNodes>
class Kratos::BoussinesqElement< TNumNodes >