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::PlaneApproximationUtility< TDim > Class Template Reference

Utility to compute an approximation plane for a set of points. More...

#include <plane_approximation_utility.h>

Collaboration diagram for Kratos::PlaneApproximationUtility< TDim >:

Public Member Functions

Type Definitions
 KRATOS_CLASS_POINTER_DEFINITION (PlaneApproximationUtility)
 Pointer definition of PlaneApproximationUtility. More...
 
Operators
 PlaneApproximationUtility ()
 Default constructor. More...
 
virtual ~PlaneApproximationUtility ()
 Destructor. More...
 

Static Public Member Functions

Operations
static void ComputePlaneApproximation (const std::vector< array_1d< double, 3 > > &rPointsCoords, array_1d< double, 3 > &rPlaneBasePointCoords, array_1d< double, 3 > &rPlaneNormal)
 Provided a list of point coordinates, computes the best plane approximation in a least squares sense. More...
 

Detailed Description

template<unsigned int TDim>
class Kratos::PlaneApproximationUtility< TDim >

Utility to compute an approximation plane for a set of points.

Provided a set of points, this utility computes the plane that best approximate them in a least square sense. The base point of the plane is the set of points average coordinates while the plane normal is taken as the eigenvector associated to the minimum eigenvalue of the matrix A. Matrix A is trans(P)*P, being P the matrix that stores in each row the difference between the base point and each one of the points to approximate.

Author
Ruben Zorrilla

Constructor & Destructor Documentation

◆ PlaneApproximationUtility()

template<unsigned int TDim>
Kratos::PlaneApproximationUtility< TDim >::PlaneApproximationUtility ( )
inline

Default constructor.

◆ ~PlaneApproximationUtility()

template<unsigned int TDim>
virtual Kratos::PlaneApproximationUtility< TDim >::~PlaneApproximationUtility ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ ComputePlaneApproximation()

template<unsigned int TDim>
static void Kratos::PlaneApproximationUtility< TDim >::ComputePlaneApproximation ( const std::vector< array_1d< double, 3 > > &  rPointsCoords,
array_1d< double, 3 > &  rPlaneBasePointCoords,
array_1d< double, 3 > &  rPlaneNormal 
)
inlinestatic

Provided a list of point coordinates, computes the best plane approximation in a least squares sense.

Parameters
rPointsCoordsVector containing the set of point coordinates
Returns
rPlaneBasePointCoords Plane base point
rPlaneNormal Plane normal

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<unsigned int TDim>
Kratos::PlaneApproximationUtility< TDim >::KRATOS_CLASS_POINTER_DEFINITION ( PlaneApproximationUtility< TDim >  )

Pointer definition of PlaneApproximationUtility.


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