bitpit::ReconstructionAssembler Class Reference

The ReconstructionAssembler class allows to define reconstruction polynomial. More...

Inheritance diagram for bitpit::ReconstructionAssembler:

Public Types
enum	ReconstructionType { TYPE_CONSTRAINT , TYPE_LEAST_SQUARE }

Public Member Functions
	ReconstructionAssembler ()
	ReconstructionAssembler (uint8_t degree, uint8_t dimensions)
void	addCellAverageEquation (ReconstructionType type, const Cell &cell, const std::array< double, 3 > &origin, const std::array< double, 3 > *vertexCoords, double scaleFactor=1.)
void	addPointDerivativeEquation (ReconstructionType type, const std::array< double, 3 > &origin, const std::array< double, 3 > &point, const std::array< double, 3 > &direction, double scaleFactor=1.)
void	addPointValueEquation (ReconstructionType type, const std::array< double, 3 > &origin, const std::array< double, 3 > &point, double scaleFactor=1.)
void	assembleKernel (ReconstructionKernel *kernel) const
void	clear (bool release=true)
int	countConstraints () const
int	countEquations () const
int	countLeastSquares () const
uint16_t	getCoefficientCount () const
uint8_t	getDegree () const
uint8_t	getDimensions () const
void	initialize (uint8_t degree, uint8_t dimensions, bool release=true)
void	swap (ReconstructionAssembler &other) noexcept
void	updateKernel (ReconstructionKernel *kernel) const

Detailed Description

The ReconstructionAssembler class allows to define reconstruction polynomial.

Definition at line 245 of file reconstruction.hpp.

Member Enumeration Documentation

ReconstructionType

enum bitpit::ReconstructionAssembler::ReconstructionType

Definition at line 248 of file reconstruction.hpp.

Constructor & Destructor Documentation

ReconstructionAssembler() [1/2]

bitpit::ReconstructionAssembler::ReconstructionAssembler

(

)

Constructor.

Definition at line 3130 of file reconstruction.cpp.

ReconstructionAssembler() [2/2]

bitpit::ReconstructionAssembler::ReconstructionAssembler	(	uint8_t	degree,
		uint8_t	dimensions )

Constructor.

Parameters

degree	is the degree of the polynomial
dimensions	is the number of space dimensions

Definition at line 3141 of file reconstruction.cpp.

Member Function Documentation

addCellAverageEquation()

void bitpit::ReconstructionAssembler::addCellAverageEquation	(	ReconstructionType	type,
		const Cell &	cell,
		const std::array< double, 3 > &	origin,
		const std::array< double, 3 > *	vertexCoords,
		double	scaleFactor = 1. )

Add a cell average equation.

Parameters

type	is the type of reconstruction associated to the equation
cell	is the cell
origin	is the point chosen as origin of the reconstruction
vertexCoords	are the vertices' coordinates
scaleFactor	the scale factor associated to the equation

Definition at line 3341 of file reconstruction.cpp.

addPointDerivativeEquation()

void bitpit::ReconstructionAssembler::addPointDerivativeEquation	(	ReconstructionType	type,
		const std::array< double, 3 > &	origin,
		const std::array< double, 3 > &	point,
		const std::array< double, 3 > &	direction,
		double	scaleFactor = 1. )

Add a point derivative equation.

Parameters

type	is the type of reconstruction associated to the equation
origin	is the point chosen as origin of the reconstruction
point	is the point were the basis will be evaluated
direction	is the direction of the derivative
scaleFactor	the scale factor associated to the equation

Definition at line 3322 of file reconstruction.cpp.

addPointValueEquation()

void bitpit::ReconstructionAssembler::addPointValueEquation	(	ReconstructionType	type,
		const std::array< double, 3 > &	origin,
		const std::array< double, 3 > &	point,
		double	scaleFactor = 1. )

Add a point value equation.

Parameters

type	is the type of reconstruction associated to the equation
origin	is the point chosen as origin of the reconstruction
point	is the point were the basis will be evaluated
scaleFactor	the scale factor associated to the equation

Definition at line 3304 of file reconstruction.cpp.

assembleKernel()

void bitpit::ReconstructionAssembler::assembleKernel

(

ReconstructionKernel *

kernel

)

const

Assembles the reconstruction kernel.

Before computing kernel weights, the kernel will be properly initialized and possible unneeded memory hold by the kernel will be released.

Parameters

[out]

kernel

on output will contain the reconstruction kernel

Definition at line 3403 of file reconstruction.cpp.

clear()

void bitpit::ReconstructionAssembler::clear

(

bool

release = true

)

Clear the reconstruction.

Parameters

release

if true, the memory hold by the assembler will be released, otherwise the assembler will be cleared but its memory will not be released

Definition at line 3199 of file reconstruction.cpp.

countConstraints()

int bitpit::ReconstructionAssembler::countConstraints

(

)

const

Count the number of constrain-type equations added to the assembler.

Returns

The number of constraint-type equations added to the assembler.

Definition at line 3267 of file reconstruction.cpp.

countEquations()

int bitpit::ReconstructionAssembler::countEquations

(

)

const

Count the number of equations added to the assembler.

Returns

The number of equations added to the assembler.

Definition at line 3287 of file reconstruction.cpp.

countLeastSquares()

int bitpit::ReconstructionAssembler::countLeastSquares

(

)

const

Count the number of least square-type equations added to the assembler.

Returns

The number of least square-type equations added to the assembler.

Definition at line 3277 of file reconstruction.cpp.

getCoefficientCount()

uint16_t bitpit::ReconstructionAssembler::getCoefficientCount

(

)

const

Get the number of coefficients of the reconstruction polynomial.

Returns

The number of coefficients of the reconstruction polynomial.

Definition at line 3257 of file reconstruction.cpp.

getDegree()

uint8_t bitpit::ReconstructionAssembler::getDegree

(

)

const

Get the degree of the polynomial.

Returns

The degree of the polynomial.

Definition at line 3237 of file reconstruction.cpp.

getDimensions()

uint8_t bitpit::ReconstructionAssembler::getDimensions

(

)

const

Get the number of space dimensions.

Returns

The number of space dimensions.

Definition at line 3247 of file reconstruction.cpp.

initialize()

void bitpit::ReconstructionAssembler::initialize	(	uint8_t	degree,
		uint8_t	dimensions,
		bool	release = true )

Initialize the assembler.

Parameters

degree	is the degree of the polynomial
dimensions	is the number of space dimensions
release	if true, possible unneeded memory hold by the assembler will be released, otherwise the assembler will be initialized but possible unneeded memory will not be released

Definition at line 3180 of file reconstruction.cpp.

swap()

void bitpit::ReconstructionAssembler::swap ( ReconstructionAssembler & other )

noexcept

Exchanges the content of the reconstruction by the content the specified other reconstruction.

Parameters

other

is another reconstruction whose content is swapped with that of this reconstruction

Definition at line 3153 of file reconstruction.cpp.

updateKernel()

void bitpit::ReconstructionAssembler::updateKernel

(

ReconstructionKernel *

kernel

)

const

Updates the reconstruction kernel.

Before computing kernel weights, the kernel will not be initialized.

Parameters

[out]

kernel

on output will contain the reconstruction kernel

Definition at line 3424 of file reconstruction.cpp.

---

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

• src/discretization/reconstruction.hpp
• src/discretization/reconstruction.cpp