programmer's documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Functions
cs_field_operator.h File Reference
#include "cs_defs.h"
#include "cs_field.h"
#include "cs_gradient.h"
Include dependency graph for cs_field_operator.h:

Go to the source code of this file.

Functions

void cs_field_gradient_scalar (const cs_field_t *f, bool use_previous_t, cs_gradient_type_t gradient_type, cs_halo_type_t halo_type, int inc, bool recompute_cocg, int n_r_sweeps, int verbosity, int clip_mode, double epsilon, double extrap, double clip_coeff, cs_real_3_t *restrict grad)
 Compute cell gradient of scalar field or component of vector or tensor field. More...
 
void cs_field_gradient_potential (const cs_field_t *f, bool use_previous_t, cs_gradient_type_t gradient_type, cs_halo_type_t halo_type, int inc, bool recompute_cocg, int n_r_sweeps, int hyd_p_flag, int verbosity, int clip_mode, double epsilon, double extrap, double clip_coeff, cs_real_3_t f_ext[], cs_real_3_t *restrict grad)
 Compute cell gradient of scalar field or component of vector or tensor field. More...
 
void cs_field_gradient_vector (const cs_field_t *f, bool use_previous_t, cs_gradient_type_t gradient_type, cs_halo_type_t halo_type, int inc, int n_r_sweeps, int verbosity, int clip_mode, double epsilon, double clip_coeff, cs_real_33_t *restrict grad)
 Compute cell gradient of scalar field or component of vector or tensor field. More...
 

Function Documentation

void cs_field_gradient_potential ( const cs_field_t f,
bool  use_previous_t,
cs_gradient_type_t  gradient_type,
cs_halo_type_t  halo_type,
int  inc,
bool  recompute_cocg,
int  n_r_sweeps,
int  hyd_p_flag,
int  verbosity,
int  clip_mode,
double  epsilon,
double  extrap,
double  clip_coeff,
cs_real_3_t  f_ext[],
cs_real_3_t *restrict  grad 
)

Compute cell gradient of scalar field or component of vector or tensor field.

Parameters
[in]fpointer to field
[in]use_previous_tshould we use values from the previous time step ?
[in]gradient_typegradient type
[in]halo_typehalo type
[in]incif 0, solve on increment; 1 otherwise
[in]recompute_cocgshould COCG FV quantities be recomputed ?
[in]n_r_sweepsif > 1, number of reconstruction sweeps
[in]hyd_p_flagflag for hydrostatic pressure
[in]verbosityverbosity level
[in]clip_modeclipping mode
[in]epsilonprecision for iterative gradient calculation
[in]extrapboundary gradient extrapolation coefficient
[in]clip_coeffclipping coefficient
[in]f_extexterior force generating the hydrostatic pressure
[out]gradgradient
void cs_field_gradient_scalar ( const cs_field_t f,
bool  use_previous_t,
cs_gradient_type_t  gradient_type,
cs_halo_type_t  halo_type,
int  inc,
bool  recompute_cocg,
int  n_r_sweeps,
int  verbosity,
int  clip_mode,
double  epsilon,
double  extrap,
double  clip_coeff,
cs_real_3_t *restrict  grad 
)

Compute cell gradient of scalar field or component of vector or tensor field.

(end ignore by Doxygen)

(end ignore by Doxygen)

Parameters
[in]fpointer to field
[in]use_previous_tshould we use values from the previous time step ?
[in]gradient_typegradient type
[in]halo_typehalo type
[in]incif 0, solve on increment; 1 otherwise
[in]recompute_cocgshould COCG FV quantities be recomputed ?
[in]n_r_sweepsif > 1, number of reconstruction sweeps
[in]verbosityverbosity level
[in]clip_modeclipping mode
[in]epsilonprecision for iterative gradient calculation
[in]extrapboundary gradient extrapolation coefficient
[in]clip_coeffclipping coefficient
[out]gradgradient
void cs_field_gradient_vector ( const cs_field_t f,
bool  use_previous_t,
cs_gradient_type_t  gradient_type,
cs_halo_type_t  halo_type,
int  inc,
int  n_r_sweeps,
int  verbosity,
int  clip_mode,
double  epsilon,
double  clip_coeff,
cs_real_33_t *restrict  grad 
)

Compute cell gradient of scalar field or component of vector or tensor field.

Parameters
[in]fpointer to field
[in]use_previous_tshould we use values from the previous time step ?
[in]gradient_typegradient type
[in]halo_typehalo type
[in]incif 0, solve on increment; 1 otherwise
[in]recompute_cocgshould COCG FV quantities be recomputed ?
[in]n_r_sweepsif > 1, number of reconstruction sweeps
[in]verbosityverbosity level
[in]clip_modeclipping mode
[in]epsilonprecision for iterative gradient calculation
[in]extrapboundary gradient extrapolation coefficient
[in]clip_coeffclipping coefficient
[in]f_extexterior force generating the hydrostatic pressure
[out]gradgradient