Alsvinn  0.5.3
The fast FVM simulator with UQ support
Public Member Functions | List of all members
alsfvm::functional::Moment Class Reference

#include <alsfvm/functional/Moment.hpp>

Inheritance diagram for alsfvm::functional::Moment:
alsfvm::functional::Functional

Public Member Functions

 Moment (const Parameters &parameters)
 
virtual void operator() (volume::Volume &conservedVolumeOut, const volume::Volume &conservedVolumeIn, const real weight, const grid::Grid &grid) override
 
virtual ivec3 getFunctionalSize (const grid::Grid &grid) const override
 Returns grid.getDimensions() More...
 
virtual ivec3 getGhostCellSizes (const grid::Grid &grid, const volume::Volume &volume) const override
 
- Public Member Functions inherited from alsfvm::functional::Functional
virtual ~Functional ()
 
virtual std::string getPlatformToAllocateOn (const std::string &platform) const
 

Additional Inherited Members

- Public Types inherited from alsfvm::functional::Functional
typedef alsutils::parameters::Parameters Parameters
 To be used to pass parameters to the constructors. More...
 

Detailed Description

Computes the $m$-th moment, that is outputs

\[u_{i,j,k}^m\]

Constructor & Destructor Documentation

◆ Moment()

alsfvm::functional::Moment::Moment ( const Parameters parameters)

The following parameters are accepted through parameters

Name Description
degree the exponent m

Member Function Documentation

◆ getFunctionalSize()

ivec3 alsfvm::functional::Moment::getFunctionalSize ( const grid::Grid grid) const
overridevirtual

Returns grid.getDimensions()

Implements alsfvm::functional::Functional.

◆ getGhostCellSizes()

ivec3 alsfvm::functional::Moment::getGhostCellSizes ( const grid::Grid grid,
const volume::Volume volume 
) const
overridevirtual

Reimplemented from alsfvm::functional::Functional.

◆ operator()()

void alsfvm::functional::Moment::operator() ( volume::Volume conservedVolumeOut,
const volume::Volume conservedVolumeIn,
const real  weight,
const grid::Grid grid 
)
overridevirtual

Computes the operator value on the givne input data

Note
In order to support time integration, the result should be added to conservedVolumeOut and extraVolumeOut, not overriding it.
Parameters
[out]conservedVolumeOutat the end, should have the contribution of the functional for the conservedVariables
[in]conservedVolumeInthe state of the conserved variables
[in]weightthe current weight to be applied to the functional. Ie, the functional should compute
conservedVolumeOut += weight + f(conservedVolumeIn)
[in]gridthe grid to use

Implements alsfvm::functional::Functional.


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