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

Go to the source code of this file.

Enumerations

enum  cs_turbomachinery_model_t { CS_TURBOMACHINERY_NONE, CS_TURBOMACHINERY_FROZEN, CS_TURBOMACHINERY_TRANSIENT }
 

Functions

void cs_turbomachinery_set_model (cs_turbomachinery_model_t model)
 Define rotor/stator model. More...
 
cs_turbomachinery_model_t cs_turbomachinery_get_model (void)
 Return rotor/stator model. More...
 
void cs_turbomachinery_add_rotor (const char *cell_criteria, double rotation_velocity, const double rotation_axis[3])
 Define a rotor by its axis and cell selection criteria. More...
 
int cs_turbomachinery_join_add (const char *sel_criteria, float fraction, float plane, int verbosity, int visualization)
 Add a cs_join_t structure to the list of rotor/stator joinings. More...
 
void cs_turbomachinery_initialize (void)
 Initializations for turbomachinery computation. More...
 
void cs_turbomachinery_finalize (void)
 Free turbomachinery structure. More...
 
void cs_turbomachinery_update_mesh (double t_cur_mob, double *t_elapsed)
 Update mesh for unsteady rotor/stator computation. More...
 
void cs_turbomachinery_reinit_i_face_fields (void)
 Reinitialize interior face-based fields. More...
 
void cs_turbomachinery_resize_cell_fields (void)
 Resize cell-based fields. More...
 
void cs_turbomachinery_rotate_fields (const cs_real_t dt[])
 Rotation of vector and tensor fields. More...
 

Enumeration Type Documentation

Enumerator
CS_TURBOMACHINERY_NONE 
CS_TURBOMACHINERY_FROZEN 
CS_TURBOMACHINERY_TRANSIENT 

Function Documentation

void cs_turbomachinery_add_rotor ( const char *  cell_criteria,
double  rotation_velocity,
const double  rotation_axis[3] 
)

Define a rotor by its axis and cell selection criteria.

Parameters
[in]cell_criteriacell selection criteria string
[in]rotation_velocityrotation velocity, in radians/second
[in]rotation_axisrotation axis vector
void cs_turbomachinery_finalize ( void  )

Free turbomachinery structure.

cs_turbomachinery_model_t cs_turbomachinery_get_model ( void  )

Return rotor/stator model.

void cs_turbomachinery_initialize ( void  )

Initializations for turbomachinery computation.

Note
This function should be called before once the mesh is built, but before cs_post_init_meshes() so that postprocessing meshes are updated correctly in the transient case.
int cs_turbomachinery_join_add ( const char *  sel_criteria,
float  fraction,
float  plane,
int  verbosity,
int  visualization 
)

Add a cs_join_t structure to the list of rotor/stator joinings.

Parameters
[in]sel_criteriaboundary face selection criteria
[in]fractionvalue of the fraction parameter
[in]planevalue of the plane parameter
[in]verbositylevel of verbosity required
[in]visualizationlevel of visualization required
Returns
number (1 to n) associated with new joining
void cs_turbomachinery_reinit_i_face_fields ( void  )

Reinitialize interior face-based fields.

void cs_turbomachinery_resize_cell_fields ( void  )

Resize cell-based fields.

This function only handles fields owning their values.

void cs_turbomachinery_rotate_fields ( const cs_real_t  dt[])

Rotation of vector and tensor fields.

void cs_turbomachinery_set_model ( cs_turbomachinery_model_t  model)

Define rotor/stator model.

(end ignore by Doxygen)

void cs_turbomachinery_update_mesh ( double  t_cur_mob,
double *  t_elapsed 
)

Update mesh for unsteady rotor/stator computation.

Parameters
[in]t_cur_mobcurrent rotor time
[out]t_elapsedelapsed computation time