cs_walldistance.h File Reference

#include "base/cs_base.h"
#include "cdo/cs_equation.h"

Include dependency graph for cs_walldistance.h:

Go to the source code of this file.

Functions
bool	cs_walldistance_is_activated (void)
	Test if the computation of the wall distance is activated.
void	cs_walldistance_activate (void)
	Activate the future computation of the wall distance.
void	cs_walldistance_setup (void)
	Setup the equation related to the wall distance.
void	cs_walldistance_compute (const cs_mesh_t *mesh, const cs_time_step_t *time_step, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq)
	Compute the wall distance.

Function Documentation

cs_walldistance_activate()

void cs_walldistance_activate

(

void

)

Activate the future computation of the wall distance.

cs_walldistance_compute()

void cs_walldistance_compute	(	const cs_mesh_t *	mesh,
		const cs_time_step_t *	time_step,
		const cs_cdo_connect_t *	connect,
		const cs_cdo_quantities_t *	cdoq )

Compute the wall distance.

Parameters

[in]	mesh	pointer to a cs_mesh_t structure
[in]	time_step	pointer to a cs_time_step_t structure
[in]	connect	pointer to a cs_cdo_connect_t structure
[in]	cdoq	pointer to a cs_cdo_quantities_t structure

cs_walldistance_is_activated()

bool cs_walldistance_is_activated

(

void

)

Test if the computation of the wall distance is activated.

Returns

true if the wall distance computation is requested, false otherwise

cs_walldistance_setup()

void cs_walldistance_setup

(

void

)

Setup the equation related to the wall distance.