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::GaussPointItem Class Reference

Custom Gauss Point container to be used by the search. More...

#include <gauss_point_item.h>

Inheritance diagram for Kratos::GaussPointItem:
Collaboration diagram for Kratos::GaussPointItem:

Public Member Functions

Life Cycle
 GaussPointItem ()
 Default constructor. More...
 
 GaussPointItem (const array_1d< double, 3 > &Coordinates)
 Constructor with coordinates. More...
 
 GaussPointItem (const array_1d< double, 3 > &Coordinates, ConstitutiveLaw::Pointer pConstitutiveLaw, const double Weight)
 Complete constructor. More...
 
 GaussPointItem (const GaussPointItem &GP)=default
 Copy constructor (not really required) More...
 
 ~GaussPointItem () override=default
 Destructor. More...
 
Operations
Point GetPoint ()
 Returns the point. More...
 
void SetPoint (const Point &Point)
 Set the point. More...
 
void SetConstitutiveLaw (ConstitutiveLaw::Pointer pConstitutiveLaw)
 Sets the Constitutive Law associated to the point. More...
 
ConstitutiveLaw::Pointer GetConstitutiveLaw ()
 Returns the Constitutive Law associated to the point. More...
 
double GetWeight () const
 Returns the integration weigth associated to the point. More...
 
void SetWeight (const double Weight)
 Sets the integration weigth associated to the point. More...
 
bool Has (const Variable< double > &rVariable)
 It checks if an ID exists in the map. More...
 
bool Has (const Variable< array_1d< double, 3 >> &rVariable)
 It checks if an ID exists in the map. More...
 
bool Has (const Variable< Vector > &rVariable)
 It checks if an ID exists in the map. More...
 
bool Has (const Variable< Matrix > &rVariable)
 It checks if an ID exists in the map. More...
 
void SetValue (const Variable< double > &rVariable, const double rValue)
 It adds a new value to the map (double) More...
 
void SetValue (const Variable< array_1d< double, 3 >> &rVariable, const array_1d< double, 3 > &rValue)
 It adds a new value to the map (array_1d<double, 3>) More...
 
void SetValue (const Variable< Vector > &rVariable, const Vector &rValue)
 It adds a new value to the map (Vector) More...
 
void SetValue (const Variable< Matrix > &rVariable, const Matrix &rValue)
 It adds a new value to the map (Matrix) More...
 
double GetValue (const Variable< double > &rVariable, double &rValue)
 It return a value from the map (double) More...
 
array_1d< double, 3 > GetValue (const Variable< array_1d< double, 3 >> &rVariable, array_1d< double, 3 > &rValue)
 It return a value from the map (array_1d<double, 3>) More...
 
Vector GetValue (const Variable< Vector > &rVariable, Vector &rValue)
 It return a value from the map (Vector) More...
 
Matrix GetValue (const Variable< Matrix > &rVariable, Matrix &rValue)
 It return a value from the map (Matrix) More...
 
void RemoveId (const IndexType VariableKey)
 It removes one particular pair from the map. More...
 
- Public Member Functions inherited from Kratos::Point
 Point ()
 Default constructor. More...
 
 Point (double NewX, double NewY=0, double NewZ=0)
 3d constructor. More...
 
 Point (Point const &rOtherPoint)
 
 Point (CoordinatesArrayType const &rOtherCoordinates)
 
template<class TVectorType >
 Point (vector_expression< TVectorType > const &rOtherCoordinates)
 
 Point (std::vector< double > const &rOtherCoordinates)
 
virtual ~Point ()
 Destructor. More...
 
Pointoperator= (const Point &rOther)
 Assignment operator. More...
 
bool operator== (const Point &rOther) const
 
double SquaredDistance (const Point &rOtherPoint) const
 This method computes the distance between this point and another one (squared) More...
 
double Distance (const Point &rOtherPoint) const
 This method computes the distance between this point and another one. More...
 
virtual std::string Info () const
 Turn back information as a string. More...
 
virtual void PrintInfo (std::ostream &rOStream) const
 Print information about this object. More...
 
virtual void PrintData (std::ostream &rOStream) const
 Print object's data. More...
 
 KRATOS_CLASS_POINTER_DEFINITION (Point)
 Pointer definition of Point. More...
 
double X () const
 
double Y () const
 
double Z () const
 
doubleX ()
 
doubleY ()
 
doubleZ ()
 
CoordinatesArrayType const & Coordinates () const
 
CoordinatesArrayTypeCoordinates ()
 
- Public Member Functions inherited from Kratos::array_1d< double, 3 >
BOOST_UBLAS_INLINE array_1d ()
 Default constructor. More...
 
BOOST_UBLAS_INLINE array_1d (size_type array_size)
 
BOOST_UBLAS_INLINE array_1d (size_type array_size, value_type v)
 
BOOST_UBLAS_INLINE array_1d (const std::initializer_list< value_type > &rInitList)
 
BOOST_UBLAS_INLINE array_1d (size_type array_size, const array_type &rdata)
 
BOOST_UBLAS_INLINE array_1d (const array_1d &v)
 
BOOST_UBLAS_INLINE array_1d (const boost::numeric::ublas::vector_expression< AE > &ae)
 
BOOST_UBLAS_INLINE const_reference operator() (size_type i) const
 
BOOST_UBLAS_INLINE reference operator() (size_type i)
 
BOOST_UBLAS_INLINE const_reference operator[] (size_type i) const
 
BOOST_UBLAS_INLINE reference operator[] (size_type i)
 
BOOST_UBLAS_INLINE array_1doperator= (const array_1d &v)
 
BOOST_UBLAS_INLINE array_1doperator= (const boost::numeric::ublas::vector_expression< AE > &ae)
 
BOOST_UBLAS_INLINE array_1doperator+= (const boost::numeric::ublas::vector_expression< AE > &ae)
 
BOOST_UBLAS_INLINE array_1doperator-= (const boost::numeric::ublas::vector_expression< AE > &ae)
 
BOOST_UBLAS_INLINE array_1doperator/= (const AT &at)
 
BOOST_UBLAS_INLINE bool operator== (const array_1d &v) const
 Compares whether this array_1d is equal to the given array_1d. More...
 
 KRATOS_CLASS_POINTER_DEFINITION (array_1d)
 Pointer definition of array_1d. More...
 
BOOST_UBLAS_INLINE const_iterator find (size_type i) const
 
BOOST_UBLAS_INLINE iterator find (size_type i)
 
BOOST_UBLAS_INLINE size_type size () const
 
BOOST_UBLAS_INLINE array_1dminus_assign (const boost::numeric::ublas::vector_expression< AE > &ae)
 
BOOST_UBLAS_INLINE const array_typedata () const
 
BOOST_UBLAS_INLINE array_typedata ()
 
BOOST_UBLAS_INLINE const_iterator begin () const
 
BOOST_UBLAS_INLINE iterator begin ()
 
BOOST_UBLAS_INLINE const_iterator end () const
 
BOOST_UBLAS_INLINE iterator end ()
 
BOOST_UBLAS_INLINE const_reverse_iterator rbegin () const
 
BOOST_UBLAS_INLINE reverse_iterator rbegin ()
 
BOOST_UBLAS_INLINE const_reverse_iterator rend () const
 
BOOST_UBLAS_INLINE reverse_iterator rend ()
 
BOOST_UBLAS_INLINE void resize (size_type array_size, bool preserve=true)
 
BOOST_UBLAS_INLINE array_1dassign_temporary (array_1d &v)
 
BOOST_UBLAS_INLINE array_1doperator*= (const AT &at)
 
BOOST_UBLAS_INLINE array_1dplus_assign (const boost::numeric::ublas::vector_expression< AE > &ae)
 
BOOST_UBLAS_INLINE array_1dassign (const boost::numeric::ublas::vector_expression< AE > &ae)
 
BOOST_UBLAS_INLINE void swap (array_1d &v)
 
BOOST_UBLAS_INLINE reference insert_element (size_type i, const_reference t)
 
BOOST_UBLAS_INLINE void erase_element (size_type i)
 
BOOST_UBLAS_INLINE void clear ()
 

Type Definitions

typedef std::size_t IndexType
 The type used to idenify index and key. More...
 
 KRATOS_CLASS_POINTER_DEFINITION (GaussPointItem)
 Counted pointer of GaussPointItem. More...
 

Additional Inherited Members

- Public Types inherited from Kratos::Point
typedef array_1d< double, mDimension > BaseType
 
typedef BaseType CoordinatesArrayType
 
typedef std::size_t SizeType
 
typedef std::size_t IndexType
 
- Public Types inherited from Kratos::array_1d< double, 3 >
typedef std::size_t size_type
 
typedef std::ptrdiff_t difference_type
 
typedef double value_type
 
typedef boost::numeric::ublas::type_traits< double >::const_reference const_reference
 
typedef double & reference
 
typedef std::array< double, N > array_type
 
typedef double * pointer
 
typedef array_1d< double, N > self_type
 
typedef const boost::numeric::ublas::vector_reference< const self_typeconst_closure_type
 
typedef boost::numeric::ublas::vector_reference< self_typeclosure_type
 
typedef self_type vector_temporary_type
 
typedef boost::numeric::ublas::dense_tag storage_category
 
typedef boost::numeric::ublas::reverse_iterator_base< const_iterator > const_reverse_iterator
 
typedef boost::numeric::ublas::reverse_iterator_base< iterator > reverse_iterator
 
- Static Public Member Functions inherited from Kratos::Point
static constexpr IndexType Dimension ()
 

Detailed Description

Custom Gauss Point container to be used by the search.

Author
Vicente Mataix Ferrandiz

Member Typedef Documentation

◆ IndexType

typedef std::size_t Kratos::GaussPointItem::IndexType

The type used to idenify index and key.

Constructor & Destructor Documentation

◆ GaussPointItem() [1/4]

Kratos::GaussPointItem::GaussPointItem ( )
inline

Default constructor.

It just computes the default constructor of the point

◆ GaussPointItem() [2/4]

Kratos::GaussPointItem::GaussPointItem ( const array_1d< double, 3 > &  Coordinates)
inline

Constructor with coordinates.

It just computes the coordinates constructor of the point

◆ GaussPointItem() [3/4]

Kratos::GaussPointItem::GaussPointItem ( const array_1d< double, 3 > &  Coordinates,
ConstitutiveLaw::Pointer  pConstitutiveLaw,
const double  Weight 
)
inline

Complete constructor.

Computes the point constructor + Considers the CL pointer and the integration weight

◆ GaussPointItem() [4/4]

Kratos::GaussPointItem::GaussPointItem ( const GaussPointItem GP)
default

Copy constructor (not really required)

◆ ~GaussPointItem()

Kratos::GaussPointItem::~GaussPointItem ( )
overridedefault

Destructor.

Member Function Documentation

◆ GetConstitutiveLaw()

ConstitutiveLaw::Pointer Kratos::GaussPointItem::GetConstitutiveLaw ( )
inline

Returns the Constitutive Law associated to the point.

Returns
mpConstitutiveLaw: The pointer to the Constitutive Law associated to the point

◆ GetPoint()

Point Kratos::GaussPointItem::GetPoint ( )
inline

Returns the point.

Returns
The point

◆ GetValue() [1/4]

array_1d<double, 3> Kratos::GaussPointItem::GetValue ( const Variable< array_1d< double, 3 >> &  rVariable,
array_1d< double, 3 > &  rValue 
)
inline

It return a value from the map (array_1d<double, 3>)

Parameters
rVariableThe variable being recovered
rValueThe value to recover
Returns
rValue The value to recover

◆ GetValue() [2/4]

double Kratos::GaussPointItem::GetValue ( const Variable< double > &  rVariable,
double rValue 
)
inline

It return a value from the map (double)

Parameters
rVariableThe variable being recovered
rValueThe value to recover
Returns
rValue The value to recover

◆ GetValue() [3/4]

Matrix Kratos::GaussPointItem::GetValue ( const Variable< Matrix > &  rVariable,
Matrix rValue 
)
inline

It return a value from the map (Matrix)

Parameters
rVariableThe variable being recovered
rValueThe value to recover
Returns
rValue The value to recover

◆ GetValue() [4/4]

Vector Kratos::GaussPointItem::GetValue ( const Variable< Vector > &  rVariable,
Vector rValue 
)
inline

It return a value from the map (Vector)

Parameters
rVariableThe variable being recovered
rValueThe value to recover
Returns
rValue The value to recover

◆ GetWeight()

double Kratos::GaussPointItem::GetWeight ( ) const
inline

Returns the integration weigth associated to the point.

Returns
mWeight: The pointer to the Constitutive Law associated to the point

◆ Has() [1/4]

bool Kratos::GaussPointItem::Has ( const Variable< array_1d< double, 3 >> &  rVariable)
inline

It checks if an ID exists in the map.

Parameters
rVariableThe variable to be check
Returns
If the ID already exists or not

◆ Has() [2/4]

bool Kratos::GaussPointItem::Has ( const Variable< double > &  rVariable)
inline

It checks if an ID exists in the map.

Parameters
rVariableThe variable to be check
Returns
If the ID already exists or not

◆ Has() [3/4]

bool Kratos::GaussPointItem::Has ( const Variable< Matrix > &  rVariable)
inline

It checks if an ID exists in the map.

Parameters
rVariableThe variable to be check
Returns
If the ID already exists or not

◆ Has() [4/4]

bool Kratos::GaussPointItem::Has ( const Variable< Vector > &  rVariable)
inline

It checks if an ID exists in the map.

Parameters
rVariableThe variable to be check
Returns
If the ID already exists or not

◆ KRATOS_CLASS_POINTER_DEFINITION()

Kratos::GaussPointItem::KRATOS_CLASS_POINTER_DEFINITION ( GaussPointItem  )

Counted pointer of GaussPointItem.

◆ RemoveId()

void Kratos::GaussPointItem::RemoveId ( const IndexType  VariableKey)
inline

It removes one particular pair from the map.

Parameters
VariableKeyThe variable ID to remove

◆ SetConstitutiveLaw()

void Kratos::GaussPointItem::SetConstitutiveLaw ( ConstitutiveLaw::Pointer  pConstitutiveLaw)
inline

Sets the Constitutive Law associated to the point.

Parameters
pConstitutiveLawThe pointer to the Constitutive Law

◆ SetPoint()

void Kratos::GaussPointItem::SetPoint ( const Point Point)
inline

Set the point.

Parameters
PointThe point

◆ SetValue() [1/4]

void Kratos::GaussPointItem::SetValue ( const Variable< array_1d< double, 3 >> &  rVariable,
const array_1d< double, 3 > &  rValue 
)
inline

It adds a new value to the map (array_1d<double, 3>)

Parameters
rVariableThe variable being set
rValueThe value to assign

◆ SetValue() [2/4]

void Kratos::GaussPointItem::SetValue ( const Variable< double > &  rVariable,
const double  rValue 
)
inline

It adds a new value to the map (double)

Parameters
rVariableThe variable being set
rValueThe value to assign

◆ SetValue() [3/4]

void Kratos::GaussPointItem::SetValue ( const Variable< Matrix > &  rVariable,
const Matrix rValue 
)
inline

It adds a new value to the map (Matrix)

Parameters
rVariableThe variable being set
rValueThe value to assign

◆ SetValue() [4/4]

void Kratos::GaussPointItem::SetValue ( const Variable< Vector > &  rVariable,
const Vector rValue 
)
inline

It adds a new value to the map (Vector)

Parameters
rVariableThe variable being set
rValueThe value to assign

◆ SetWeight()

void Kratos::GaussPointItem::SetWeight ( const double  Weight)
inline

Sets the integration weigth associated to the point.

Parameters
WeightThe integration weight

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