Public Member Functions | Private Attributes | List of all members
oomph::VorticityRecoveryHelpers::RecoveryHelper Class Reference

Class to indicate which derivatives of the vorticity/ velocity we want to recover. We choose to immediately instantiate an object of this class by dropping the semi-colon after the class description. More...

#include <vorticity_smoother.h>

Public Member Functions

 RecoveryHelper ()
 Constructor. More...
 
int maximum_order_of_vorticity_derivative () const
 The maximum order of derivatives calculated in the vorticity recovery. More...
 
int maximum_order_of_velocity_derivative () const
 The maximum order of derivatives calculated in the velocity recovery. More...
 
void set_maximum_order_of_vorticity_derivative (const int &max_deriv)
 The maximum order of derivatives calculated in the vorticity recovery. More...
 
void set_maximum_order_of_velocity_derivative (const int &max_deriv)
 The maximum order of derivatives calculated in the velocity recovery. More...
 
void calculate_number_of_values_per_field ()
 Calculates the number of values per field given the number of vorticity and velocity derivatives to recover (stored as private data) More...
 
unsigned npartial_derivative (const unsigned &n) const
 Helper function that determines the number of n-th order partial derivatives in d-dimensions. Specifically there are (n+d-1)(choose)(d-1) possible n-th order partial derivatives in d-dimensions. Implementation makes use of the code found at: www.geeksforgeeks.org/space-and-time-efficient-binomial-coefficient/. More...
 
unsigned ncont_interpolated_values () const
 Number of continuously interpolated values: More...
 

Private Attributes

unsigned Number_of_values_per_field
 Number of values per field; how many of the following do we want: u,v,p,omega,d/dx,d/dy, d^2/dx^2,d^2/dxdy,d^2/dy^2, d^3/dx^3,d^3/dx^2dy,d^3/dxdy^2,d^3/dy^3, du/dx,du/dy,dv/dx,dv/dy. More...
 
int Maximum_order_of_vorticity_derivative
 Maximum number of derivatives to retain in the vorticity recovery. Note, the value -1 means we ONLY output u,v[,w],p. More...
 
int Maximum_order_of_velocity_derivative
 Maximum number of derivatives to retain in the velocity recovery. Note, the value 0 means we don't calculate the derivatives of the velocity. More...
 

Detailed Description

Class to indicate which derivatives of the vorticity/ velocity we want to recover. We choose to immediately instantiate an object of this class by dropping the semi-colon after the class description.

Definition at line 54 of file vorticity_smoother.h.

Constructor & Destructor Documentation

◆ RecoveryHelper()

oomph::VorticityRecoveryHelpers::RecoveryHelper::RecoveryHelper ( )
inline

Member Function Documentation

◆ calculate_number_of_values_per_field()

void oomph::VorticityRecoveryHelpers::RecoveryHelper::calculate_number_of_values_per_field ( )
inline

Calculates the number of values per field given the number of vorticity and velocity derivatives to recover (stored as private data)

Definition at line 126 of file vorticity_smoother.h.

References i, Maximum_order_of_velocity_derivative, Maximum_order_of_vorticity_derivative, npartial_derivative(), and Number_of_values_per_field.

Referenced by set_maximum_order_of_velocity_derivative(), and set_maximum_order_of_vorticity_derivative().

◆ maximum_order_of_velocity_derivative()

int oomph::VorticityRecoveryHelpers::RecoveryHelper::maximum_order_of_velocity_derivative ( ) const
inline

The maximum order of derivatives calculated in the velocity recovery.

Definition at line 75 of file vorticity_smoother.h.

References Maximum_order_of_velocity_derivative.

Referenced by oomph::VorticitySmootherElement< ELEMENT >::VorticitySmootherElement().

◆ maximum_order_of_vorticity_derivative()

int oomph::VorticityRecoveryHelpers::RecoveryHelper::maximum_order_of_vorticity_derivative ( ) const
inline

The maximum order of derivatives calculated in the vorticity recovery.

Definition at line 68 of file vorticity_smoother.h.

References Maximum_order_of_vorticity_derivative.

Referenced by oomph::VorticitySmootherElement< ELEMENT >::VorticitySmootherElement().

◆ ncont_interpolated_values()

unsigned oomph::VorticityRecoveryHelpers::RecoveryHelper::ncont_interpolated_values ( ) const
inline

Number of continuously interpolated values:

Definition at line 191 of file vorticity_smoother.h.

References Number_of_values_per_field.

Referenced by oomph::VorticitySmootherElement< ELEMENT >::VorticitySmootherElement().

◆ npartial_derivative()

unsigned oomph::VorticityRecoveryHelpers::RecoveryHelper::npartial_derivative ( const unsigned &  n) const
inline

Helper function that determines the number of n-th order partial derivatives in d-dimensions. Specifically there are (n+d-1)(choose)(d-1) possible n-th order partial derivatives in d-dimensions. Implementation makes use of the code found at: www.geeksforgeeks.org/space-and-time-efficient-binomial-coefficient/.

Definition at line 155 of file vorticity_smoother.h.

References i.

Referenced by calculate_number_of_values_per_field(), and oomph::VorticitySmootherElement< ELEMENT >::npartial_derivative().

◆ set_maximum_order_of_velocity_derivative()

void oomph::VorticityRecoveryHelpers::RecoveryHelper::set_maximum_order_of_velocity_derivative ( const int &  max_deriv)
inline

The maximum order of derivatives calculated in the velocity recovery.

Definition at line 103 of file vorticity_smoother.h.

References calculate_number_of_values_per_field(), and Maximum_order_of_velocity_derivative.

◆ set_maximum_order_of_vorticity_derivative()

void oomph::VorticityRecoveryHelpers::RecoveryHelper::set_maximum_order_of_vorticity_derivative ( const int &  max_deriv)
inline

The maximum order of derivatives calculated in the vorticity recovery.

Definition at line 82 of file vorticity_smoother.h.

References calculate_number_of_values_per_field(), and Maximum_order_of_vorticity_derivative.

Member Data Documentation

◆ Maximum_order_of_velocity_derivative

int oomph::VorticityRecoveryHelpers::RecoveryHelper::Maximum_order_of_velocity_derivative
private

Maximum number of derivatives to retain in the velocity recovery. Note, the value 0 means we don't calculate the derivatives of the velocity.

Definition at line 211 of file vorticity_smoother.h.

Referenced by calculate_number_of_values_per_field(), maximum_order_of_velocity_derivative(), RecoveryHelper(), and set_maximum_order_of_velocity_derivative().

◆ Maximum_order_of_vorticity_derivative

int oomph::VorticityRecoveryHelpers::RecoveryHelper::Maximum_order_of_vorticity_derivative
private

Maximum number of derivatives to retain in the vorticity recovery. Note, the value -1 means we ONLY output u,v[,w],p.

Definition at line 206 of file vorticity_smoother.h.

Referenced by calculate_number_of_values_per_field(), maximum_order_of_vorticity_derivative(), RecoveryHelper(), and set_maximum_order_of_vorticity_derivative().

◆ Number_of_values_per_field

unsigned oomph::VorticityRecoveryHelpers::RecoveryHelper::Number_of_values_per_field
private

Number of values per field; how many of the following do we want: u,v,p,omega,d/dx,d/dy, d^2/dx^2,d^2/dxdy,d^2/dy^2, d^3/dx^3,d^3/dx^2dy,d^3/dxdy^2,d^3/dy^3, du/dx,du/dy,dv/dx,dv/dy.

Definition at line 202 of file vorticity_smoother.h.

Referenced by calculate_number_of_values_per_field(), and ncont_interpolated_values().


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