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

Internal container for integration point statistitcs on a given element. More...

#include <statistics_data.h>

Collaboration diagram for Kratos::StatisticsData:

Public Member Functions

Life Cycle
 StatisticsData ()
 Default constructor. More...
 
 StatisticsData (StatisticsData const &rOther)
 Copy constructor. More...
 
virtual ~StatisticsData ()
 Destructor. More...
 
Operators
StatisticsDataoperator= (StatisticsData const &rOther)
 Assignment operator. More...
 
Operations
void InitializeStorage (Element &rElement, std::size_t MeasurementSize)
 Initialize internal storage for this container. More...
 
void UpdateMeasurement (const Element &rElement, const PointerVector< StatisticsSampler > &rStatisticsSamplers, const PointerVector< StatisticsSampler > &rHigherOrderStatistics, ValueContainerType &rUpdate, const std::size_t NumMeasurements)
 Record a new realization for the measured statistics. More...
 
void WriteToCSVOutput (std::ofstream &rOutputStream, const Element &rElement, const PointerVector< StatisticsSampler > &rRecordedStatistics, const PointerVector< StatisticsSampler > &rHigherOrderStatistics, const std::size_t NumberOfMeasurements, const std::string &rSeparator) const
 Write computed statistics to output file. More...
 
Inquiry
std::size_t NumberOfIntegrationPoints () const
 How many integration points this container holds data for. More...
 
std::size_t NumberOfStatisticalQuantities () const
 How many quantities this container holds data for. More...
 
Access
IntegrationPointDataView IntegrationPointData (std::size_t IntegrationPointIndex)
 Access internal data for a given integration point. More...
 
IntegrationPointDataConstView IntegrationPointData (std::size_t IntegrationPointIndex) const
 Access internal data for a given integration point. More...
 
Input and output
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...
 

Protected Member Functions

Protected Operations
void CalculateGeometryData (const Geometry< Node > &rGeometry, const GeometryData::IntegrationMethod IntegrationMethod, Matrix &rN, typename Geometry< Node >::ShapeFunctionsGradientsType &rDN_DX) const
 

Type Definitions

typedef std::vector< doubleValueContainerType
 
typedef Matrix::iterator1 IntegrationPointDataView
 
typedef Matrix::const_iterator1 IntegrationPointDataConstView
 
 KRATOS_CLASS_POINTER_DEFINITION (StatisticsData)
 Pointer definition of StatisticsData. More...
 

Serialization

class Serializer
 

Detailed Description

Internal container for integration point statistitcs on a given element.

See also
StatisticsRecord
IntegrationPointStatisticsProcess.

Member Typedef Documentation

◆ IntegrationPointDataConstView

◆ IntegrationPointDataView

◆ ValueContainerType

Constructor & Destructor Documentation

◆ StatisticsData() [1/2]

Kratos::StatisticsData::StatisticsData ( )
inline

Default constructor.

◆ StatisticsData() [2/2]

Kratos::StatisticsData::StatisticsData ( StatisticsData const &  rOther)
inline

Copy constructor.

◆ ~StatisticsData()

virtual Kratos::StatisticsData::~StatisticsData ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ CalculateGeometryData()

void Kratos::StatisticsData::CalculateGeometryData ( const Geometry< Node > &  rGeometry,
const GeometryData::IntegrationMethod  IntegrationMethod,
Matrix rN,
typename Geometry< Node >::ShapeFunctionsGradientsType &  rDN_DX 
) const
inlineprotected

◆ Info()

virtual std::string Kratos::StatisticsData::Info ( ) const
inlinevirtual

Turn back information as a string.

◆ InitializeStorage()

void Kratos::StatisticsData::InitializeStorage ( Element rElement,
std::size_t  MeasurementSize 
)
inline

Initialize internal storage for this container.

Parameters
rElementThe element instance this container stores data for.
MeasurementSizeTotal number of quantities that are recorded. For vector and matrix statistics, each component should be counted as a different quantity.

◆ IntegrationPointData() [1/2]

IntegrationPointDataView Kratos::StatisticsData::IntegrationPointData ( std::size_t  IntegrationPointIndex)
inline

Access internal data for a given integration point.

Parameters
IntegrationPointIndexindex of the requested integration point.

◆ IntegrationPointData() [2/2]

IntegrationPointDataConstView Kratos::StatisticsData::IntegrationPointData ( std::size_t  IntegrationPointIndex) const
inline

Access internal data for a given integration point.

Parameters
IntegrationPointIndexindex of the requested integration point.

◆ KRATOS_CLASS_POINTER_DEFINITION()

Kratos::StatisticsData::KRATOS_CLASS_POINTER_DEFINITION ( StatisticsData  )

Pointer definition of StatisticsData.

◆ NumberOfIntegrationPoints()

std::size_t Kratos::StatisticsData::NumberOfIntegrationPoints ( ) const
inline

How many integration points this container holds data for.

◆ NumberOfStatisticalQuantities()

std::size_t Kratos::StatisticsData::NumberOfStatisticalQuantities ( ) const
inline

How many quantities this container holds data for.

When working with vector or matrix quantities, each individual component is counted as a different quantity.

◆ operator=()

StatisticsData& Kratos::StatisticsData::operator= ( StatisticsData const &  rOther)
inline

Assignment operator.

◆ PrintData()

virtual void Kratos::StatisticsData::PrintData ( std::ostream &  rOStream) const
inlinevirtual

Print object's data.

◆ PrintInfo()

virtual void Kratos::StatisticsData::PrintInfo ( std::ostream &  rOStream) const
inlinevirtual

Print information about this object.

◆ UpdateMeasurement()

void Kratos::StatisticsData::UpdateMeasurement ( const Element rElement,
const PointerVector< StatisticsSampler > &  rStatisticsSamplers,
const PointerVector< StatisticsSampler > &  rHigherOrderStatistics,
ValueContainerType rUpdate,
const std::size_t  NumMeasurements 
)
inline

Record a new realization for the measured statistics.

This function assumes that InitializeStorage has been called in advance.

Parameters
rElementThe element instance this container stores data for.
rRecordedStatisticsList of first order statistics stored in this container.
rHigherOrderStatisticsList of higher order statistics stored in this container.
NumberOfMeasurementsHow many times this function has been called so far (including this one).

◆ WriteToCSVOutput()

void Kratos::StatisticsData::WriteToCSVOutput ( std::ofstream &  rOutputStream,
const Element rElement,
const PointerVector< StatisticsSampler > &  rRecordedStatistics,
const PointerVector< StatisticsSampler > &  rHigherOrderStatistics,
const std::size_t  NumberOfMeasurements,
const std::string &  rSeparator 
) const
inline

Write computed statistics to output file.

Parameters
rOutputStreamoutput file stream.
rElementElement instance this container stores data for.
rRecordedStatisticsList of first order statistics stored in this container.
rHigherOrderStatisticsList of higher order statistics stored in this container.
NumberOfMeasurementsHow many realizations have been recorded up to this point.
rSeparatorSeparator to use in the output file.

Friends And Related Function Documentation

◆ Serializer

friend class Serializer
friend

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