cs_navsto_coupling.c File Reference

Routines to handle the settings of coupling algorithms. More...

#include "cs_defs.h"
#include <assert.h>
#include <stdlib.h>
#include <string.h>
#include <bft_mem.h>
#include "cs_navsto_coupling.h"

Include dependency graph for cs_navsto_coupling.c:

Macros
#define	CS_NAVSTO_COUPLING_DBG   0

Functions
void *	cs_navsto_uzawa_create_context (cs_navsto_param_t *nsp, cs_param_bc_type_t bc)
	Allocate and initialize a context structure when the Navier-Stokes system is coupled using an Uzawa-Augmented Lagrangian approach. More...
void *	cs_navsto_uzawa_free_context (const cs_navsto_param_t *nsp, void *context)
	Free the context structure related to an Uzawa-Augmented Lagrangian approach. More...
void	cs_navsto_uzawa_init_setup (const cs_navsto_param_t *nsp, void *context)
	Start setting-up the Navier-Stokes equations when a Uzawa Augmented Lagrangian algorithm is used to coupled the system No mesh information is available at this stage. More...
void	cs_navsto_uzawa_last_setup (const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, const cs_navsto_param_t *nsp, void *context)
	Finalize the setup for the Navier-Stokes equations when an Uzawa Augmented Lagrangian algorithm is used to coupled the system. Connectivity and geometric quantities are available at this stage. More...
cs_equation_t *	cs_navsto_uzawa_get_momentum_eq (void *context)
	Retrieve the pointer to the cs_equation_t structure related to the momentum equation in case of Uzawa coupling. More...
void *	cs_navsto_ac_create_context (cs_navsto_param_t *nsp, cs_param_bc_type_t bc)
	Allocate and initialize a context structure when the Navier-Stokes system is coupled using an Artificial Compressibility approach. More...
void *	cs_navsto_ac_free_context (const cs_navsto_param_t *nsp, void *context)
	Free the context structure related to an Artificial Compressibility approach. More...
void	cs_navsto_ac_init_setup (const cs_navsto_param_t *nsp, void *context)
	Start setting-up the Navier-Stokes equations when an Artificial Compressibility algorithm is used to coupled the system. No mesh information is available at this stage. More...
void	cs_navsto_ac_last_setup (const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, const cs_navsto_param_t *nsp, void *context)
	Finalize the setup for the Navier-Stokes equations when an Artificial Compressibility algorithm is used to coupled the system. Connectivity and geometric quantities are available at this stage. More...
cs_equation_t *	cs_navsto_ac_get_momentum_eq (void *context)
	Retrieve the pointer to the cs_equation_t structure related to the momentum equation in case of artificial compressibility coupling. More...
void *	cs_navsto_ac_vpp_create_context (cs_navsto_param_t *nsp, cs_param_bc_type_t bc)
	Allocate and initialize a context structure when the Navier-Stokes system is coupled using an Artificial Compressibility - VPP approach. More...
void *	cs_navsto_ac_vpp_free_context (const cs_navsto_param_t *nsp, void *context)
	Free the context structure related to an Artificial Compressibility with the VPP approach. More...
void	cs_navsto_ac_vpp_init_setup (const cs_navsto_param_t *nsp, void *context)
	Start setting-up the Navier-Stokes equations when an Artificial Compressibility with VPP algorithm is used to coupled the system. No mesh information is available at this stage. More...
void	cs_navsto_ac_vpp_last_setup (const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, const cs_navsto_param_t *nsp, void *context)
	Finalize the setup for the Navier-Stokes equations when an Artificial Compressibility algorithm is used to coupled the system. Connectivity and geometric quantities are available at this stage. More...
cs_equation_t *	cs_navsto_ac_vpp_get_momentum_eq (void *context)
	Retrieve the pointer to the cs_equation_t structure related to the momentum equation in case of artificial compressibility coupling with the VPP extension. More...
void *	cs_navsto_monolithic_create_context (cs_navsto_param_t *nsp, cs_param_bc_type_t bc)
	Allocate and initialize a context structure when the Navier-Stokes system is coupled using a monolithic approach. More...
void *	cs_navsto_monolithic_free_context (const cs_navsto_param_t *nsp, void *context)
	Free the context structure related to a monolithic approach. More...
void	cs_navsto_monolithic_init_setup (const cs_navsto_param_t *nsp, void *context)
	Start setting-up the Navier-Stokes equations when a monolithic algorithm is used to coupled the system. No mesh information is available at this stage. More...
void	cs_navsto_monolithic_last_setup (const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, const cs_navsto_param_t *nsp, void *context)
	Finalize the setup for the Navier-Stokes equations when a monolithic algorithm is used to coupled the system. Connectivity and geometric quantities are available at this stage. More...
cs_equation_t *	cs_navsto_monolithic_get_momentum_eq (void *context)
	Retrieve the pointer to the cs_equation_t structure related to the momentum equation in case of a monolithic coupling. More...
void *	cs_navsto_projection_create_context (cs_navsto_param_t *nsp, cs_param_bc_type_t bc)
	Allocate and initialize a context structure when the Navier-Stokes system is coupled using an incremental Projection approach in the the rotational form (see Minev & Guermond, 2006, JCP) More...
void *	cs_navsto_projection_free_context (const cs_navsto_param_t *nsp, void *context)
	Free the context structure related to a Projection approach. More...
void	cs_navsto_projection_init_setup (const cs_navsto_param_t *nsp, int loc_id, bool has_previous, void *context)
	Start setting-up the Navier-Stokes equations when a projection algorithm is used to coupled the system. No mesh information is available at this stage. More...
void	cs_navsto_projection_last_setup (const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, const cs_navsto_param_t *nsp, void *context)
	Finalize the setup for the Navier-Stokes equations when a projection algorithm is used to coupled the system. Connectivity and geometric quantities are available at this stage. More...
cs_equation_t *	cs_navsto_projection_get_momentum_eq (void *context)
	Retrieve the pointer to the cs_equation_t structure related to the momentum equation in case of a projection coupling. More...

Detailed Description

Routines to handle the settings of coupling algorithms.

• Uzawa-Augmented Lagrangian algorithm
• Artificial Compressibility algorithm
• Its variant VVP (Vector Projection Penalty) algorithm
• Projection algorithm

Macro Definition Documentation

CS_NAVSTO_COUPLING_DBG

#define CS_NAVSTO_COUPLING_DBG   0

Function Documentation

cs_navsto_ac_create_context()

void* cs_navsto_ac_create_context	(	cs_navsto_param_t *	nsp,
		cs_param_bc_type_t	bc
	)

Allocate and initialize a context structure when the Navier-Stokes system is coupled using an Artificial Compressibility approach.

Parameters

[in]	nsp	pointer to a cs_navsto_param_t structure
[in]	bc	default cs_param_bc_type_t for the equation

Returns

a pointer to the context structure

cs_navsto_ac_free_context()

void* cs_navsto_ac_free_context	(	const cs_navsto_param_t *	nsp,
		void *	context
	)

Free the context structure related to an Artificial Compressibility approach.

Parameters

[in]	nsp	pointer to a cs_navsto_param_t structure
[in,out]	context	pointer to a context structure cast on-the-fly

Returns

a NULL pointer

cs_navsto_ac_get_momentum_eq()

cs_equation_t* cs_navsto_ac_get_momentum_eq

(

void *

context

)

Retrieve the pointer to the cs_equation_t structure related to the momentum equation in case of artificial compressibility coupling.

Parameters

[in]

context

pointer to a context structure cast on-the-fly

Returns

a pointer to a cs_equation_t structure

cs_navsto_ac_init_setup()

void cs_navsto_ac_init_setup	(	const cs_navsto_param_t *	nsp,
		void *	context
	)

Start setting-up the Navier-Stokes equations when an Artificial Compressibility algorithm is used to coupled the system. No mesh information is available at this stage.

Parameters

[in]	nsp	pointer to a cs_navsto_param_t structure
[in,out]	context	pointer to a context structure cast on-the-fly

cs_navsto_ac_last_setup()

void cs_navsto_ac_last_setup	(	const cs_cdo_connect_t *	connect,
		const cs_cdo_quantities_t *	quant,
		const cs_navsto_param_t *	nsp,
		void *	context
	)

Finalize the setup for the Navier-Stokes equations when an Artificial Compressibility algorithm is used to coupled the system. Connectivity and geometric quantities are available at this stage.

Parameters

[in]	connect	pointer to a cs_cdo_connect_t structure
[in]	quant	pointer to a cs_cdo_quantities_t structure
[in]	nsp	pointer to a cs_navsto_param_t structure
[in,out]	context	pointer to a context structure cast on-the-fly

cs_navsto_ac_vpp_create_context()

void* cs_navsto_ac_vpp_create_context	(	cs_navsto_param_t *	nsp,
		cs_param_bc_type_t	bc
	)

Allocate and initialize a context structure when the Navier-Stokes system is coupled using an Artificial Compressibility - VPP approach.

Parameters

[in]	nsp	pointer to a cs_navsto_param_t structure
[in]	bc	default cs_param_bc_type_t for the equation

Returns

a pointer to the context structure

cs_navsto_ac_vpp_free_context()

void* cs_navsto_ac_vpp_free_context	(	const cs_navsto_param_t *	nsp,
		void *	context
	)

Free the context structure related to an Artificial Compressibility with the VPP approach.

Parameters

[in]	nsp	pointer to a cs_navsto_param_t structure
[in,out]	context	pointer to a context structure cast on-the-fly

Returns

a NULL pointer

cs_navsto_ac_vpp_get_momentum_eq()

cs_equation_t* cs_navsto_ac_vpp_get_momentum_eq

(

void *

context

)

Retrieve the pointer to the cs_equation_t structure related to the momentum equation in case of artificial compressibility coupling with the VPP extension.

Parameters

[in]

context

pointer to a context structure cast on-the-fly

Returns

a pointer to a cs_equation_t structure

cs_navsto_ac_vpp_init_setup()

void cs_navsto_ac_vpp_init_setup	(	const cs_navsto_param_t *	nsp,
		void *	context
	)

Start setting-up the Navier-Stokes equations when an Artificial Compressibility with VPP algorithm is used to coupled the system. No mesh information is available at this stage.

Parameters

[in]	nsp	pointer to a cs_navsto_param_t structure
[in,out]	context	pointer to a context structure cast on-the-fly

cs_navsto_ac_vpp_last_setup()

void cs_navsto_ac_vpp_last_setup	(	const cs_cdo_connect_t *	connect,
		const cs_cdo_quantities_t *	quant,
		const cs_navsto_param_t *	nsp,
		void *	context
	)

Finalize the setup for the Navier-Stokes equations when an Artificial Compressibility algorithm is used to coupled the system. Connectivity and geometric quantities are available at this stage.

Parameters

[in]	connect	pointer to a cs_cdo_connect_t structure
[in]	quant	pointer to a cs_cdo_quantities_t structure
[in]	nsp	pointer to a cs_navsto_param_t structure
[in,out]	context	pointer to a context structure cast on-the-fly

cs_navsto_monolithic_create_context()

void* cs_navsto_monolithic_create_context	(	cs_navsto_param_t *	nsp,
		cs_param_bc_type_t	bc
	)

Allocate and initialize a context structure when the Navier-Stokes system is coupled using a monolithic approach.

Parameters

[in]	nsp	pointer to a cs_navsto_param_t structure
[in]	bc	default cs_param_bc_type_t for the equation

Returns

a pointer to the context structure

cs_navsto_monolithic_free_context()

void* cs_navsto_monolithic_free_context	(	const cs_navsto_param_t *	nsp,
		void *	context
	)

Free the context structure related to a monolithic approach.

Parameters

[in]	nsp	pointer to a cs_navsto_param_t structure
[in,out]	context	pointer to a context structure cast on-the-fly

Returns

a NULL pointer

cs_navsto_monolithic_get_momentum_eq()

cs_equation_t* cs_navsto_monolithic_get_momentum_eq

(

void *

context

)

Retrieve the pointer to the cs_equation_t structure related to the momentum equation in case of a monolithic coupling.

Parameters

[in]

context

pointer to a context structure cast on-the-fly

Returns

a pointer to a cs_equation_t structure

cs_navsto_monolithic_init_setup()

void cs_navsto_monolithic_init_setup	(	const cs_navsto_param_t *	nsp,
		void *	context
	)

Start setting-up the Navier-Stokes equations when a monolithic algorithm is used to coupled the system. No mesh information is available at this stage.

Parameters

[in]	nsp	pointer to a cs_navsto_param_t structure
[in,out]	context	pointer to a context structure cast on-the-fly

cs_navsto_monolithic_last_setup()

void cs_navsto_monolithic_last_setup	(	const cs_cdo_connect_t *	connect,
		const cs_cdo_quantities_t *	quant,
		const cs_navsto_param_t *	nsp,
		void *	context
	)

Finalize the setup for the Navier-Stokes equations when a monolithic algorithm is used to coupled the system. Connectivity and geometric quantities are available at this stage.

Parameters

[in]	connect	pointer to a cs_cdo_connect_t structure
[in]	quant	pointer to a cs_cdo_quantities_t structure
[in]	nsp	pointer to a cs_navsto_param_t structure
[in,out]	context	pointer to a context structure cast on-the-fly

cs_navsto_projection_create_context()

void* cs_navsto_projection_create_context	(	cs_navsto_param_t *	nsp,
		cs_param_bc_type_t	bc
	)

Allocate and initialize a context structure when the Navier-Stokes system is coupled using an incremental Projection approach in the the rotational form (see Minev & Guermond, 2006, JCP)

Parameters

[in]	nsp	pointer to a cs_navsto_param_t structure
[in]	bc	default cs_param_bc_type_t for the equation

Returns

a pointer to the context structure

cs_navsto_projection_free_context()

void* cs_navsto_projection_free_context	(	const cs_navsto_param_t *	nsp,
		void *	context
	)

Free the context structure related to a Projection approach.

Parameters

[in]	nsp	pointer to a cs_navsto_param_t structure
[in,out]	context	pointer to a context structure cast on-the-fly

Returns

a NULL pointer

cs_navsto_projection_get_momentum_eq()

cs_equation_t* cs_navsto_projection_get_momentum_eq

(

void *

context

)

Retrieve the pointer to the cs_equation_t structure related to the momentum equation in case of a projection coupling.

Parameters

[in]

context

pointer to a context structure cast on-the-fly

Returns

a pointer to a cs_equation_t structure

cs_navsto_projection_init_setup()

void cs_navsto_projection_init_setup	(	const cs_navsto_param_t *	nsp,
		int	loc_id,
		bool	has_previous,
		void *	context
	)

Start setting-up the Navier-Stokes equations when a projection algorithm is used to coupled the system. No mesh information is available at this stage.

Parameters

[in]	nsp	pointer to a cs_navsto_param_t structure
[in]	loc_id	id related to a mesh location
[in]	has_previous	values at different time steps (true/false)
[in,out]	context	pointer to a context structure cast on-the-fly

cs_navsto_projection_last_setup()

void cs_navsto_projection_last_setup	(	const cs_cdo_connect_t *	connect,
		const cs_cdo_quantities_t *	quant,
		const cs_navsto_param_t *	nsp,
		void *	context
	)

Finalize the setup for the Navier-Stokes equations when a projection algorithm is used to coupled the system. Connectivity and geometric quantities are available at this stage.

Parameters

[in]	connect	pointer to a cs_cdo_connect_t structure
[in]	quant	pointer to a cs_cdo_quantities_t structure
[in]	nsp	pointer to a cs_navsto_param_t structure
[in,out]	context	pointer to a context structure cast on-the-fly

cs_navsto_uzawa_create_context()

void* cs_navsto_uzawa_create_context	(	cs_navsto_param_t *	nsp,
		cs_param_bc_type_t	bc
	)

Allocate and initialize a context structure when the Navier-Stokes system is coupled using an Uzawa-Augmented Lagrangian approach.

Parameters

[in]	nsp	pointer to a cs_navsto_param_t structure
[in]	bc	default cs_param_bc_type_t for the equation

Returns

a pointer to the context structure

cs_navsto_uzawa_free_context()

void* cs_navsto_uzawa_free_context	(	const cs_navsto_param_t *	nsp,
		void *	context
	)

Free the context structure related to an Uzawa-Augmented Lagrangian approach.

Parameters

[in]	nsp	pointer to a cs_navsto_param_t structure
[in,out]	context	pointer to a context structure cast on-the-fly

Returns

a NULL pointer

cs_navsto_uzawa_get_momentum_eq()

cs_equation_t* cs_navsto_uzawa_get_momentum_eq

(

void *

context

)

Retrieve the pointer to the cs_equation_t structure related to the momentum equation in case of Uzawa coupling.

Parameters

[in]

context

pointer to a context structure cast on-the-fly

Returns

a pointer to a cs_equation_t structure

cs_navsto_uzawa_init_setup()

void cs_navsto_uzawa_init_setup	(	const cs_navsto_param_t *	nsp,
		void *	context
	)

Start setting-up the Navier-Stokes equations when a Uzawa Augmented Lagrangian algorithm is used to coupled the system No mesh information is available at this stage.

Parameters

[in]	nsp	pointer to a cs_navsto_param_t structure
[in,out]	context	pointer to a context structure cast on-the-fly

cs_navsto_uzawa_last_setup()

void cs_navsto_uzawa_last_setup	(	const cs_cdo_connect_t *	connect,
		const cs_cdo_quantities_t *	quant,
		const cs_navsto_param_t *	nsp,
		void *	context
	)

Finalize the setup for the Navier-Stokes equations when an Uzawa Augmented Lagrangian algorithm is used to coupled the system. Connectivity and geometric quantities are available at this stage.

Parameters

[in]	connect	pointer to a cs_cdo_connect_t structure
[in]	quant	pointer to a cs_cdo_quantities_t structure
[in]	nsp	pointer to a cs_navsto_param_t structure
[in,out]	context	pointer to a context structure cast on-the-fly