ECOGEN 6.0
Evolutive, Compressible, Open, Genuine, Easy, N-phase
Loading...
Searching...
No Matches
Gradient Class Reference

Base class for the gradient method. More...

#include <Gradient.h>

Inherited by GradientFiniteDifference, and GradientGreenGauss.

Public Member Functions

 Gradient ()
virtual ~Gradient ()
virtual void computeGradients (Cell *, std::vector< Coord > &, const std::vector< Variable > &, const std::vector< int > &)
 Compute gradients of a cell.
virtual const TypeGrad & getType () const

Protected Attributes

TypeGrad m_type

Detailed Description

Base class for the gradient method.

Constructor & Destructor Documentation

◆ Gradient()

Gradient::Gradient ( )

◆ ~Gradient()

Gradient::~Gradient ( )
virtual

Member Function Documentation

◆ computeGradients()

virtual void Gradient::computeGradients ( Cell * ,
std::vector< Coord > & ,
const std::vector< Variable > & ,
const std::vector< int > &  )
inlinevirtual

Compute gradients of a cell.

Parameters
cellCell whose gradient must be calculated
gradsArray of desired gradients, e.g. for temperature each component represents phase temperature and for velocity each component represents the gradient of a velocity component (grad(u), grad(v), grad(w))
nameVariablesName of the variable for which the gradient is calculated
numPhasesPhase numbers

Reimplemented in GradientFiniteDifference, and GradientGreenGauss.

Here is the call graph for this function:

◆ getType()

virtual const TypeGrad & Gradient::getType ( ) const
inlinevirtual

Member Data Documentation

◆ m_type

TypeGrad Gradient::m_type
protected

The documentation for this class was generated from the following files:
  • /home/runner/work/ECOGEN/ECOGEN/doc_sources/src/Gradients/Gradient.h
  • /home/runner/work/ECOGEN/ECOGEN/doc_sources/src/Gradients/Gradient.cpp