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

Go to the source code of this file.

Data Structures

struct  cs_lagr_attribute_map_t
 
struct  cs_lagr_particle_set_t
 
struct  cs_lagr_param_t
 

Enumerations

enum  cs_lagr_attribute_t {
  CS_LAGR_CELL_NUM, CS_LAGR_RANK_ID, CS_LAGR_SWITCH_ORDER_1, CS_LAGR_RANDOM_VALUE,
  CS_LAGR_STAT_WEIGHT, CS_LAGR_RESIDENCE_TIME, CS_LAGR_MASS, CS_LAGR_DIAMETER,
  CS_LAGR_TAUP_AUX, CS_LAGR_COORDS, CS_LAGR_VELOCITY, CS_LAGR_VELOCITY_SEEN,
  CS_LAGR_YPLUS, CS_LAGR_INTERF, CS_LAGR_NEIGHBOR_FACE_ID, CS_LAGR_MARKO_VALUE,
  CS_LAGR_DEPOSITION_FLAG, CS_LAGR_N_LARGE_ASPERITIES, CS_LAGR_N_SMALL_ASPERITIES, CS_LAGR_ADHESION_FORCE,
  CS_LAGR_ADHESION_TORQUE, CS_LAGR_DISPLACEMENT_NORM, CS_LAGR_TEMPERATURE, CS_LAGR_FLUID_TEMPERATURE,
  CS_LAGR_CP, CS_LAGR_WATER_MASS, CS_LAGR_COAL_MASS, CS_LAGR_COKE_MASS,
  CS_LAGR_SHRINKING_DIAMETER, CS_LAGR_INITIAL_DIAMETER, CS_LAGR_COAL_NUM, CS_LAGR_COAL_DENSITY,
  CS_LAGR_EMISSIVITY, CS_LAGR_STAT_CLASS, CS_LAGR_USER, CS_LAGR_N_ATTRIBUTES
}
 

Functions

void lagbeg (const cs_int_t *n_particles_max, const cs_int_t *nlayer, const cs_int_t *iphyla, const cs_int_t *idepst, const cs_int_t *irough, const cs_int_t *ireent, const cs_int_t *iclogst, const cs_int_t *nvls, const cs_int_t *nbclst, cs_lnum_t icocel[], cs_lnum_t itycel[], const cs_int_t *jisor, const cs_int_t *jisora, const cs_int_t *jirka, const cs_int_t *jord1, const cs_int_t *jrval, const cs_int_t *jrpoi, const cs_int_t *jrtsp, const cs_int_t *jdp, const cs_int_t *jmp, const cs_int_t *jxp, const cs_int_t *jyp, const cs_int_t *jzp, const cs_int_t *jup, const cs_int_t *jvp, const cs_int_t *jwp, const cs_int_t *juf, const cs_int_t *jvf, const cs_int_t *jwf, const cs_int_t *jtaux, const cs_int_t *jryplu, const cs_int_t *jrinpf, const cs_int_t *jdfac, const cs_int_t *jimark, const cs_int_t *jtp, const cs_int_t jhp[], const cs_int_t *jtf, const cs_int_t *jmwat, const cs_int_t jmch[], const cs_int_t jmck[], const cs_int_t *jcp, const cs_int_t *jrdck, const cs_int_t *jrd0p, const cs_int_t *jinch, const cs_int_t jrhock[], const cs_int_t *jreps, const cs_int_t *jdepo, const cs_int_t *jnbasg, const cs_int_t *jnbasp, const cs_int_t *jfadh, const cs_int_t *jmfadh, const cs_int_t *jndisp, const cs_int_t *jclst, const cs_int_t *jvls)
 
void prtget (const cs_int_t *nbpmax, const cs_int_t *nbpart, const cs_real_t ettp[], const cs_real_t ettpa[], const cs_int_t itepa[], const cs_real_t tepa[])
 
void prtput (const cs_int_t *nbpmax, cs_int_t *nbpart, cs_real_t *dnbpar, cs_int_t *nbpout, cs_real_t *dnbpou, cs_int_t *nbperr, cs_real_t *dnbper, cs_int_t *nbpdep, cs_real_t *dnbdep, cs_int_t *npencr, cs_real_t *dnpenc, cs_real_t ettp[], cs_real_t ettpa[], cs_int_t itepa[], cs_real_t tepa[])
 
void getbdy (const cs_int_t *nflagm, const cs_int_t *nfrlag, const cs_int_t *injcon, const cs_int_t ilflag[], const cs_int_t iusncl[], const cs_int_t iusclb[], const cs_real_t deblag[], const cs_int_t ifrlag[])
 
void dplprt (cs_int_t *p_n_particles, cs_int_t *p_scheme_order, cs_real_t boundary_stat[], const cs_int_t *iensi3, const cs_int_t *inbr, const cs_int_t *inbrbd, const cs_int_t *iflm, const cs_int_t *iflmbd, const cs_int_t *iang, const cs_int_t *iangbd, const cs_int_t *ivit, const cs_int_t *ivitbd, const cs_int_t *iencnd, const cs_int_t *iencma, const cs_int_t *iencdi, const cs_int_t *iencck, const cs_int_t *iencnbbd, const cs_int_t *iencmabd, const cs_int_t *iencdibd, const cs_int_t *iencckbd, const cs_int_t *inclg, const cs_int_t *iscovc, const cs_int_t *nusbor, cs_int_t iusb[], cs_real_t visc_length[], cs_real_t dlgeo[], cs_real_t energt[], const cs_real_t tprenc[], const cs_real_t visref[], const cs_real_t enc1[], const cs_real_t enc2[], const cs_real_t *tkelvi)
 
void ucdprt (const cs_lnum_t *nbpmax, const cs_lnum_t *nbpart, const cs_real_t *dnbpar, const cs_int_t *nbpout, const cs_real_t *dnbpou, const cs_int_t *nbperr, const cs_real_t *dnbper, const cs_int_t *nbpdep, const cs_real_t *dnbdep, const cs_int_t *npencr, const cs_real_t *dnpenc, const cs_real_t ettp[], const cs_real_t ettpa[], const cs_lnum_t itepa[], const cs_real_t tepa[])
 
void cs_lagr_get_attr_info (const cs_lagr_particle_set_t *particles, int time_id, cs_lagr_attribute_t attr, size_t *extents, size_t *size, ptrdiff_t *displ, cs_datatype_t *datatype, int *count)
 Get data extents for a given particle attribute. More...
 
cs_lagr_particle_set_tcs_lagr_get_particle_set (void)
 Return pointer to the main cs_lagr_particle_set_t structure. More...
 
void cs_lagr_destroy (void)
 Delete particle set structure and other useful buffers. More...
 
void cs_lagr_particle_set_dump (const cs_lagr_particle_set_t *particles)
 Dump a cs_lagr_particle_t structure. More...
 

Variables

const char * cs_lagr_attribute_name []
 
const cs_lagr_param_tcs_glob_lagr_params
 

Enumeration Type Documentation

Enumerator
CS_LAGR_CELL_NUM 
CS_LAGR_RANK_ID 
CS_LAGR_SWITCH_ORDER_1 
CS_LAGR_RANDOM_VALUE 
CS_LAGR_STAT_WEIGHT 
CS_LAGR_RESIDENCE_TIME 
CS_LAGR_MASS 
CS_LAGR_DIAMETER 
CS_LAGR_TAUP_AUX 
CS_LAGR_COORDS 
CS_LAGR_VELOCITY 
CS_LAGR_VELOCITY_SEEN 
CS_LAGR_YPLUS 
CS_LAGR_INTERF 
CS_LAGR_NEIGHBOR_FACE_ID 
CS_LAGR_MARKO_VALUE 
CS_LAGR_DEPOSITION_FLAG 
CS_LAGR_N_LARGE_ASPERITIES 
CS_LAGR_N_SMALL_ASPERITIES 
CS_LAGR_ADHESION_FORCE 
CS_LAGR_ADHESION_TORQUE 
CS_LAGR_DISPLACEMENT_NORM 
CS_LAGR_TEMPERATURE 
CS_LAGR_FLUID_TEMPERATURE 
CS_LAGR_CP 
CS_LAGR_WATER_MASS 
CS_LAGR_COAL_MASS 
CS_LAGR_COKE_MASS 
CS_LAGR_SHRINKING_DIAMETER 
CS_LAGR_INITIAL_DIAMETER 
CS_LAGR_COAL_NUM 
CS_LAGR_COAL_DENSITY 
CS_LAGR_EMISSIVITY 
CS_LAGR_STAT_CLASS 
CS_LAGR_USER 
CS_LAGR_N_ATTRIBUTES 

Function Documentation

void cs_lagr_destroy ( void  )

Delete particle set structure and other useful buffers.

void cs_lagr_get_attr_info ( const cs_lagr_particle_set_t particles,
int  time_id,
cs_lagr_attribute_t  attr,
size_t *  extents,
size_t *  size,
ptrdiff_t *  displ,
cs_datatype_t datatype,
int *  count 
)

Get data extents for a given particle attribute.

For attributes not currently present, the displacement and data size should be -1 and 0 respectively.

Parameters
[in]particlesassociated particle set
[in]time_idassociated time id (0: current, 1: previous)
[in]attrparticle attribute
[out]extentssize (in bytes) of particle structure, or NULL
[out]sizesize (in bytes) of attribute in particle structure, or NULL
[out]displdisplacement (in bytes) in particle structure, or NULL
[out]datatypedatatype of associated attribute, or NULL
[out]countnumber of type values associated with attribute, or NULL
cs_lagr_particle_set_t* cs_lagr_get_particle_set ( void  )

Return pointer to the main cs_lagr_particle_set_t structure.

Returns
pointer to current particle set, or NULL
void cs_lagr_particle_set_dump ( const cs_lagr_particle_set_t particles)

Dump a cs_lagr_particle_t structure.

Parameters
[in]particlescs_lagr_particle_t structure to dump
void dplprt ( cs_int_t p_n_particles,
cs_int_t p_scheme_order,
cs_real_t  boundary_stat[],
const cs_int_t iensi3,
const cs_int_t inbr,
const cs_int_t inbrbd,
const cs_int_t iflm,
const cs_int_t iflmbd,
const cs_int_t iang,
const cs_int_t iangbd,
const cs_int_t ivit,
const cs_int_t ivitbd,
const cs_int_t iencnd,
const cs_int_t iencma,
const cs_int_t iencdi,
const cs_int_t iencck,
const cs_int_t iencnbbd,
const cs_int_t iencmabd,
const cs_int_t iencdibd,
const cs_int_t iencckbd,
const cs_int_t inclg,
const cs_int_t iscovc,
const cs_int_t nusbor,
cs_int_t  iusb[],
cs_real_t  visc_length[],
cs_real_t  dlgeo[],
cs_real_t  energt[],
const cs_real_t  tprenc[],
const cs_real_t  visref[],
const cs_real_t  enc1[],
const cs_real_t  enc2[],
const cs_real_t tkelvi 
)
void getbdy ( const cs_int_t nflagm,
const cs_int_t nfrlag,
const cs_int_t injcon,
const cs_int_t  ilflag[],
const cs_int_t  iusncl[],
const cs_int_t  iusclb[],
const cs_real_t  deblag[],
const cs_int_t  ifrlag[] 
)
void lagbeg ( const cs_int_t n_particles_max,
const cs_int_t nlayer,
const cs_int_t iphyla,
const cs_int_t idepst,
const cs_int_t irough,
const cs_int_t ireent,
const cs_int_t iclogst,
const cs_int_t nvls,
const cs_int_t nbclst,
cs_lnum_t  icocel[],
cs_lnum_t  itycel[],
const cs_int_t jisor,
const cs_int_t jisora,
const cs_int_t jirka,
const cs_int_t jord1,
const cs_int_t jrval,
const cs_int_t jrpoi,
const cs_int_t jrtsp,
const cs_int_t jdp,
const cs_int_t jmp,
const cs_int_t jxp,
const cs_int_t jyp,
const cs_int_t jzp,
const cs_int_t jup,
const cs_int_t jvp,
const cs_int_t jwp,
const cs_int_t juf,
const cs_int_t jvf,
const cs_int_t jwf,
const cs_int_t jtaux,
const cs_int_t jryplu,
const cs_int_t jrinpf,
const cs_int_t jdfac,
const cs_int_t jimark,
const cs_int_t jtp,
const cs_int_t  jhp[],
const cs_int_t jtf,
const cs_int_t jmwat,
const cs_int_t  jmch[],
const cs_int_t  jmck[],
const cs_int_t jcp,
const cs_int_t jrdck,
const cs_int_t jrd0p,
const cs_int_t jinch,
const cs_int_t  jrhock[],
const cs_int_t jreps,
const cs_int_t jdepo,
const cs_int_t jnbasg,
const cs_int_t jnbasp,
const cs_int_t jfadh,
const cs_int_t jmfadh,
const cs_int_t jndisp,
const cs_int_t jclst,
const cs_int_t jvls 
)
void prtget ( const cs_int_t nbpmax,
const cs_int_t nbpart,
const cs_real_t  ettp[],
const cs_real_t  ettpa[],
const cs_int_t  itepa[],
const cs_real_t  tepa[] 
)
void prtput ( const cs_int_t nbpmax,
cs_int_t nbpart,
cs_real_t dnbpar,
cs_int_t nbpout,
cs_real_t dnbpou,
cs_int_t nbperr,
cs_real_t dnbper,
cs_int_t nbpdep,
cs_real_t dnbdep,
cs_int_t npencr,
cs_real_t dnpenc,
cs_real_t  ettp[],
cs_real_t  ettpa[],
cs_int_t  itepa[],
cs_real_t  tepa[] 
)
void ucdprt ( const cs_lnum_t nbpmax,
const cs_lnum_t nbpart,
const cs_real_t dnbpar,
const cs_int_t nbpout,
const cs_real_t dnbpou,
const cs_int_t nbperr,
const cs_real_t dnbper,
const cs_int_t nbpdep,
const cs_real_t dnbdep,
const cs_int_t npencr,
const cs_real_t dnpenc,
const cs_real_t  ettp[],
const cs_real_t  ettpa[],
const cs_lnum_t  itepa[],
const cs_real_t  tepa[] 
)

Variable Documentation

const cs_lagr_param_t* cs_glob_lagr_params
const char* cs_lagr_attribute_name[]