#include "tf_port_c.h"
#include "tfCParticle.h"
#include "tfCPotential.h"

Include dependency graph for tfCBoundaryConditions.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	tfBoundaryConditionSpaceKindHandle
	Enums for kind of boundary conditions along directions. More...

struct	tfBoundaryConditionKindHandle
	Enums for kind of individual boundary condition. More...

struct	tfBoundaryConditionHandle
	Handle to a BoundaryCondition instance. More...

struct	tfBoundaryConditionsHandle
	Handle to a BoundaryConditions instance. More...

struct	tfBoundaryConditionsArgsContainerHandle
	Handle to a BoundaryConditionsArgsContainer instance. More...

Functions
HRESULT	tfBoundaryConditionSpaceKind_init (struct tfBoundaryConditionSpaceKindHandle *handle)
	Initialize an instance.

HRESULT	tfBoundaryConditionKind_init (struct tfBoundaryConditionKindHandle *handle)
	Initialize an instance.

HRESULT	tfBoundaryCondition_getId (struct tfBoundaryConditionHandle handle, int bid)
	Get the id of a boundary condition.

HRESULT	tfBoundaryCondition_getVelocity (struct tfBoundaryConditionHandle handle, tfFloatP_t *velocity)
	Get the velocity of a boundary condition.

HRESULT	tfBoundaryCondition_setVelocity (struct tfBoundaryConditionHandle handle, tfFloatP_t velocity)
	Set the velocity of a boundary condition.

HRESULT	tfBoundaryCondition_getRestore (struct tfBoundaryConditionHandle handle, tfFloatP_t restore)
	Get the restore coefficient of a boundary condition.

HRESULT	tfBoundaryCondition_setRestore (struct tfBoundaryConditionHandle *handle, tfFloatP_t restore)
	Set the restore coefficient of a boundary condition.

HRESULT	tfBoundaryCondition_getNormal (struct tfBoundaryConditionHandle handle, tfFloatP_t *normal)
	Get the normal of a boundary condition.

HRESULT	tfBoundaryCondition_getRadius (struct tfBoundaryConditionHandle handle, tfFloatP_t radius)
	Get the equivalent radius of a boundary condition.

HRESULT	tfBoundaryCondition_setRadius (struct tfBoundaryConditionHandle *handle, tfFloatP_t radius)
	Set the equivalent radius of a boundary condition.

HRESULT	tfBoundaryCondition_setPotential (struct tfBoundaryConditionHandle handle, struct tfParticleTypeHandle partHandle, struct tfPotentialHandle *potHandle)
	Set the potential of a boundary condition for a particle type.

HRESULT	tfBoundaryConditions_getTop (struct tfBoundaryConditionsHandle handle, struct tfBoundaryConditionHandle bchandle)
	Get the top boundary condition.

HRESULT	tfBoundaryConditions_getBottom (struct tfBoundaryConditionsHandle handle, struct tfBoundaryConditionHandle bchandle)
	Get the bottom boundary condition.

HRESULT	tfBoundaryConditions_getLeft (struct tfBoundaryConditionsHandle handle, struct tfBoundaryConditionHandle bchandle)
	Get the left boundary condition.

HRESULT	tfBoundaryConditions_getRight (struct tfBoundaryConditionsHandle handle, struct tfBoundaryConditionHandle bchandle)
	Get the right boundary condition.

HRESULT	tfBoundaryConditions_getFront (struct tfBoundaryConditionsHandle handle, struct tfBoundaryConditionHandle bchandle)
	Get the front boundary condition.

HRESULT	tfBoundaryConditions_getBack (struct tfBoundaryConditionsHandle handle, struct tfBoundaryConditionHandle bchandle)
	Get the back boundary condition.

HRESULT	tfBoundaryConditions_setPotential (struct tfBoundaryConditionsHandle handle, struct tfParticleTypeHandle partHandle, struct tfPotentialHandle *potHandle)
	Set the potential on all boundaries for a particle type.

HRESULT	tfBoundaryConditions_boundedPosition (tfFloatP_t *position)
	Enforce boundary conditions on a position.

HRESULT	tfBoundaryConditionsArgsContainer_init (struct tfBoundaryConditionsArgsContainerHandle *handle)
	Initialize an instance.

HRESULT	tfBoundaryConditionsArgsContainer_destroy (struct tfBoundaryConditionsArgsContainerHandle *handle)
	Destroy an instance.

HRESULT	tfBoundaryConditionsArgsContainer_hasValueAll (struct tfBoundaryConditionsArgsContainerHandle handle, bool has)
	Test whether a value type is applied to all boundaries.

HRESULT	tfBoundaryConditionsArgsContainer_getValueAll (struct tfBoundaryConditionsArgsContainerHandle handle, unsigned int _bcValue)
	Get the boundary type value on all boundaries.

HRESULT	tfBoundaryConditionsArgsContainer_setValueAll (struct tfBoundaryConditionsArgsContainerHandle *handle, unsigned int _bcValue)
	Set the boundary type value on all boundaries.

HRESULT	tfBoundaryConditionsArgsContainer_hasValue (struct tfBoundaryConditionsArgsContainerHandle handle, const char name, bool *has)
	Test whether a boundary has a boundary type value.

HRESULT	tfBoundaryConditionsArgsContainer_getValue (struct tfBoundaryConditionsArgsContainerHandle handle, const char name, unsigned int *value)
	Get the boundary type value of a boundary.

HRESULT	tfBoundaryConditionsArgsContainer_setValue (struct tfBoundaryConditionsArgsContainerHandle handle, const char name, unsigned int value)
	Set the boundary type value of a boundary.

HRESULT	tfBoundaryConditionsArgsContainer_hasVelocity (struct tfBoundaryConditionsArgsContainerHandle handle, const char name, bool *has)
	Test whether a boundary has a velocity.

HRESULT	tfBoundaryConditionsArgsContainer_getVelocity (struct tfBoundaryConditionsArgsContainerHandle handle, const char name, tfFloatP_t **velocity)
	Get the velocity of a boundary.

HRESULT	tfBoundaryConditionsArgsContainer_setVelocity (struct tfBoundaryConditionsArgsContainerHandle handle, const char name, tfFloatP_t *velocity)
	Set the velocity of a boundary.

HRESULT	tfBoundaryConditionsArgsContainer_hasRestore (struct tfBoundaryConditionsArgsContainerHandle handle, const char name, bool *has)
	Test whether a boundary has a restore coefficient.

HRESULT	tfBoundaryConditionsArgsContainer_getRestore (struct tfBoundaryConditionsArgsContainerHandle handle, const char name, tfFloatP_t *restore)
	Get the restore coefficient of a boundary.

HRESULT	tfBoundaryConditionsArgsContainer_setRestore (struct tfBoundaryConditionsArgsContainerHandle handle, const char name, tfFloatP_t restore)
	Set the restore coefficient of a boundary.

Function Documentation

◆ tfBoundaryCondition_getId()

HRESULT tfBoundaryCondition_getId	(	struct tfBoundaryConditionHandle *	handle,
		int *	bid )

Get the id of a boundary condition.

Parameters

handle	populated handle
bid	boundary condition id

Returns: S_OK on success

◆ tfBoundaryCondition_getNormal()

HRESULT tfBoundaryCondition_getNormal	(	struct tfBoundaryConditionHandle *	handle,
		tfFloatP_t **	normal )

Get the normal of a boundary condition.

Parameters

handle	populated handle
normal	3-element allocated array of normal

Returns: S_OK on success

◆ tfBoundaryCondition_getRadius()

HRESULT tfBoundaryCondition_getRadius	(	struct tfBoundaryConditionHandle *	handle,
		tfFloatP_t *	radius )

Get the equivalent radius of a boundary condition.

Parameters

handle	populated handle
radius	equivalent radius

Returns: S_OK on success

◆ tfBoundaryCondition_getRestore()

HRESULT tfBoundaryCondition_getRestore	(	struct tfBoundaryConditionHandle *	handle,
		tfFloatP_t *	restore )

Get the restore coefficient of a boundary condition.

Parameters

handle	populated handle
restore	restore coefficient

Returns: S_OK on success

◆ tfBoundaryCondition_getVelocity()

HRESULT tfBoundaryCondition_getVelocity	(	struct tfBoundaryConditionHandle *	handle,
		tfFloatP_t **	velocity )

Get the velocity of a boundary condition.

Parameters

handle	populated handle
velocity	3-element allocated array of velocity

Returns: S_OK on success

◆ tfBoundaryCondition_setPotential()

HRESULT tfBoundaryCondition_setPotential	(	struct tfBoundaryConditionHandle *	handle,
		struct tfParticleTypeHandle *	partHandle,
		struct tfPotentialHandle *	potHandle )

Set the potential of a boundary condition for a particle type.

Parameters

handle	populated handle
partHandle	particle type
potHandle	boundary potential

Returns: S_OK on success

◆ tfBoundaryCondition_setRadius()

HRESULT tfBoundaryCondition_setRadius	(	struct tfBoundaryConditionHandle *	handle,
		tfFloatP_t	radius )

Set the equivalent radius of a boundary condition.

Parameters

handle	populated handle
radius	equivalent radius

Returns: S_OK on success

◆ tfBoundaryCondition_setRestore()

HRESULT tfBoundaryCondition_setRestore	(	struct tfBoundaryConditionHandle *	handle,
		tfFloatP_t	restore )

Set the restore coefficient of a boundary condition.

Parameters

handle	populated handle
restore	restore coefficient

Returns: S_OK on success

◆ tfBoundaryCondition_setVelocity()

HRESULT tfBoundaryCondition_setVelocity	(	struct tfBoundaryConditionHandle *	handle,
		tfFloatP_t *	velocity )

Set the velocity of a boundary condition.

Parameters

handle	populated handle
velocity	3-element allocated array of velocity

Returns: S_OK on success

◆ tfBoundaryConditionKind_init()

HRESULT tfBoundaryConditionKind_init ( struct tfBoundaryConditionKindHandle * handle )

Initialize an instance.

Parameters

handle handle to populate

Returns: S_OK on success

◆ tfBoundaryConditions_boundedPosition()

HRESULT tfBoundaryConditions_boundedPosition ( tfFloatP_t * position )

Enforce boundary conditions on a position.

Parameters

position a position to bound

Returns: S_OK on success

◆ tfBoundaryConditions_getBack()

HRESULT tfBoundaryConditions_getBack	(	struct tfBoundaryConditionsHandle *	handle,
		struct tfBoundaryConditionHandle *	bchandle )

Get the back boundary condition.

Parameters

handle	populated handle
bchandle	handle to populate

Returns: S_OK on success

◆ tfBoundaryConditions_getBottom()

HRESULT tfBoundaryConditions_getBottom	(	struct tfBoundaryConditionsHandle *	handle,
		struct tfBoundaryConditionHandle *	bchandle )

Get the bottom boundary condition.

Parameters

handle	populated handle
bchandle	handle to populate

Returns: S_OK on success

◆ tfBoundaryConditions_getFront()

HRESULT tfBoundaryConditions_getFront	(	struct tfBoundaryConditionsHandle *	handle,
		struct tfBoundaryConditionHandle *	bchandle )

Get the front boundary condition.

Parameters

handle	populated handle
bchandle	handle to populate

Returns: S_OK on success

◆ tfBoundaryConditions_getLeft()

HRESULT tfBoundaryConditions_getLeft	(	struct tfBoundaryConditionsHandle *	handle,
		struct tfBoundaryConditionHandle *	bchandle )

Get the left boundary condition.

Parameters

handle	populated handle
bchandle	handle to populate

Returns: S_OK on success

◆ tfBoundaryConditions_getRight()

HRESULT tfBoundaryConditions_getRight	(	struct tfBoundaryConditionsHandle *	handle,
		struct tfBoundaryConditionHandle *	bchandle )

Get the right boundary condition.

Parameters

handle	populated handle
bchandle	handle to populate

Returns: S_OK on success

◆ tfBoundaryConditions_getTop()

HRESULT tfBoundaryConditions_getTop	(	struct tfBoundaryConditionsHandle *	handle,
		struct tfBoundaryConditionHandle *	bchandle )

Get the top boundary condition.

Parameters

handle	populated handle
bchandle	handle to populate

Returns: S_OK on success

◆ tfBoundaryConditions_setPotential()

HRESULT tfBoundaryConditions_setPotential	(	struct tfBoundaryConditionsHandle *	handle,
		struct tfParticleTypeHandle *	partHandle,
		struct tfPotentialHandle *	potHandle )

Set the potential on all boundaries for a particle type.

Parameters

handle	populated handle
partHandle	particle type
potHandle	potential

Returns: S_OK on success

◆ tfBoundaryConditionsArgsContainer_destroy()

HRESULT tfBoundaryConditionsArgsContainer_destroy ( struct tfBoundaryConditionsArgsContainerHandle * handle )

Destroy an instance.

Parameters

handle populated handle

Returns: S_OK on success

◆ tfBoundaryConditionsArgsContainer_getRestore()

HRESULT tfBoundaryConditionsArgsContainer_getRestore	(	struct tfBoundaryConditionsArgsContainerHandle *	handle,
		const char *	name,
		tfFloatP_t *	restore )

Get the restore coefficient of a boundary.

Parameters

handle	populated handle
name	name of boundary
restore	restore coefficient

Returns: S_OK on success

◆ tfBoundaryConditionsArgsContainer_getValue()

HRESULT tfBoundaryConditionsArgsContainer_getValue	(	struct tfBoundaryConditionsArgsContainerHandle *	handle,
		const char *	name,
		unsigned int *	value )

Get the boundary type value of a boundary.

Parameters

handle	populated handle
name	name of boundary
value	boundary type value

Returns: S_OK on success

◆ tfBoundaryConditionsArgsContainer_getValueAll()

HRESULT tfBoundaryConditionsArgsContainer_getValueAll	(	struct tfBoundaryConditionsArgsContainerHandle *	handle,
		unsigned int *	_bcValue )

Get the boundary type value on all boundaries.

Parameters

handle	populated handle
_bcValue	boundary type value on all boundaries

Returns: S_OK on success

◆ tfBoundaryConditionsArgsContainer_getVelocity()

HRESULT tfBoundaryConditionsArgsContainer_getVelocity	(	struct tfBoundaryConditionsArgsContainerHandle *	handle,
		const char *	name,
		tfFloatP_t **	velocity )

Get the velocity of a boundary.

Parameters

handle	populated handle
name	name of boundary
velocity	boundary velocity

Returns: S_OK on success

◆ tfBoundaryConditionsArgsContainer_hasRestore()

HRESULT tfBoundaryConditionsArgsContainer_hasRestore	(	struct tfBoundaryConditionsArgsContainerHandle *	handle,
		const char *	name,
		bool *	has )

Test whether a boundary has a restore coefficient.

Parameters

handle	populated handle
name	name of boundary
has	flag signifying whether a boundary has a restore coefficient

Returns: S_OK on success

◆ tfBoundaryConditionsArgsContainer_hasValue()

HRESULT tfBoundaryConditionsArgsContainer_hasValue	(	struct tfBoundaryConditionsArgsContainerHandle *	handle,
		const char *	name,
		bool *	has )

Test whether a boundary has a boundary type value.

Parameters

handle	populated handle
name	name of boundary
has	flag signifying whether a boundary has a boundary type value

Returns: S_OK on success

◆ tfBoundaryConditionsArgsContainer_hasValueAll()

HRESULT tfBoundaryConditionsArgsContainer_hasValueAll	(	struct tfBoundaryConditionsArgsContainerHandle *	handle,
		bool *	has )

Test whether a value type is applied to all boundaries.

Parameters

handle	populated handle
has	flag for whether a value type is applied to all boundaries

Returns: S_OK on success

◆ tfBoundaryConditionsArgsContainer_hasVelocity()

HRESULT tfBoundaryConditionsArgsContainer_hasVelocity	(	struct tfBoundaryConditionsArgsContainerHandle *	handle,
		const char *	name,
		bool *	has )

Test whether a boundary has a velocity.

Parameters

handle	populated handle
name	name of boundary
has	flag signifying whether a boundary has a velocity

Returns: S_OK on success

◆ tfBoundaryConditionsArgsContainer_init()

HRESULT tfBoundaryConditionsArgsContainer_init ( struct tfBoundaryConditionsArgsContainerHandle * handle )

Initialize an instance.

Parameters

handle handle to populate

Returns: S_OK on success

◆ tfBoundaryConditionsArgsContainer_setRestore()

HRESULT tfBoundaryConditionsArgsContainer_setRestore	(	struct tfBoundaryConditionsArgsContainerHandle *	handle,
		const char *	name,
		tfFloatP_t	restore )

Set the restore coefficient of a boundary.

Parameters

handle	populated handle
name	name of boundary
restore	restore coefficient

Returns: S_OK on success

◆ tfBoundaryConditionsArgsContainer_setValue()

HRESULT tfBoundaryConditionsArgsContainer_setValue	(	struct tfBoundaryConditionsArgsContainerHandle *	handle,
		const char *	name,
		unsigned int	value )

Set the boundary type value of a boundary.

Parameters

handle	populated handle
name	name of boundary
value	boundary type value

Returns: S_OK on success

◆ tfBoundaryConditionsArgsContainer_setValueAll()

HRESULT tfBoundaryConditionsArgsContainer_setValueAll	(	struct tfBoundaryConditionsArgsContainerHandle *	handle,
		unsigned int	_bcValue )

Set the boundary type value on all boundaries.

Parameters

handle	populated handle
_bcValue	boundary type value on all boundaries

Returns: S_OK on success

◆ tfBoundaryConditionsArgsContainer_setVelocity()

HRESULT tfBoundaryConditionsArgsContainer_setVelocity	(	struct tfBoundaryConditionsArgsContainerHandle *	handle,
		const char *	name,
		tfFloatP_t *	velocity )

Set the velocity of a boundary.

Parameters

handle	populated handle
name	name of boundary
velocity	boundary velocity

Returns: S_OK on success

◆ tfBoundaryConditionSpaceKind_init()

HRESULT tfBoundaryConditionSpaceKind_init ( struct tfBoundaryConditionSpaceKindHandle * handle )

Initialize an instance.

Parameters

handle handle to populate

Returns: HRESULT S_OK on success

Data Structures

Functions

Function Documentation

◆ tfBoundaryCondition_getId()

◆ tfBoundaryCondition_getNormal()

◆ tfBoundaryCondition_getRadius()

◆ tfBoundaryCondition_getRestore()

◆ tfBoundaryCondition_getVelocity()

◆ tfBoundaryCondition_setPotential()

◆ tfBoundaryCondition_setRadius()

◆ tfBoundaryCondition_setRestore()

◆ tfBoundaryCondition_setVelocity()

◆ tfBoundaryConditionKind_init()

◆ tfBoundaryConditions_boundedPosition()

◆ tfBoundaryConditions_getBack()

◆ tfBoundaryConditions_getBottom()

◆ tfBoundaryConditions_getFront()

◆ tfBoundaryConditions_getLeft()

◆ tfBoundaryConditions_getRight()

◆ tfBoundaryConditions_getTop()

◆ tfBoundaryConditions_setPotential()

◆ tfBoundaryConditionsArgsContainer_destroy()

◆ tfBoundaryConditionsArgsContainer_getRestore()

◆ tfBoundaryConditionsArgsContainer_getValue()

◆ tfBoundaryConditionsArgsContainer_getValueAll()

◆ tfBoundaryConditionsArgsContainer_getVelocity()

◆ tfBoundaryConditionsArgsContainer_hasRestore()

◆ tfBoundaryConditionsArgsContainer_hasValue()

◆ tfBoundaryConditionsArgsContainer_hasValueAll()

◆ tfBoundaryConditionsArgsContainer_hasVelocity()

◆ tfBoundaryConditionsArgsContainer_init()

◆ tfBoundaryConditionsArgsContainer_setRestore()

◆ tfBoundaryConditionsArgsContainer_setValue()

◆ tfBoundaryConditionsArgsContainer_setValueAll()

◆ tfBoundaryConditionsArgsContainer_setVelocity()

◆ tfBoundaryConditionSpaceKind_init()