astaroth_utils.h File Reference

Functions for loading and updating AcMeshInfo. More...

#include "astaroth.h"

Include dependency graph for astaroth_utils.h:

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

Go to the source code of this file.

Functions
AcResult	acLoadConfig (const char *config_path, AcMeshInfo *config)
	Loads data from astaroth.conf into a config struct. More...
AcResult	acUpdateBuiltinParams (AcMeshInfo *config)
AcResult	acMeshCreate (const AcMeshInfo mesh_info, AcMesh *mesh)
AcResult	acMeshDestroy (AcMesh *mesh)
AcResult	acMeshSet (const AcReal value, AcMesh *mesh)
AcResult	acMeshRandomize (AcMesh *mesh)
AcResult	acMeshApplyPeriodicBounds (AcMesh *mesh)
AcResult	acMeshClear (AcMesh *mesh)
AcResult	acModelIntegrateStep (AcMesh mesh, const AcReal dt)
AcResult	acVerifyMesh (const AcMesh model, const AcMesh candidate)

Detailed Description

Functions for loading and updating AcMeshInfo.

Function Documentation

acLoadConfig()

AcResult acLoadConfig	(	const char *	config_path,
		AcMeshInfo *	config
	)

Loads data from astaroth.conf into a config struct.

Loads data from the config file

Returns

AC_SUCCESS on success, AC_FAILURE if there are potentially uninitialized values.

acMeshApplyPeriodicBounds()

AcResult acMeshApplyPeriodicBounds

(

AcMesh *

mesh

)

acMeshClear()

AcResult acMeshClear

(

AcMesh *

mesh

)

acMeshCreate()

AcResult acMeshCreate	(	const AcMeshInfo	mesh_info,
		AcMesh *	mesh
	)

acMeshDestroy()

AcResult acMeshDestroy

(

AcMesh *

mesh

)

acMeshRandomize()

AcResult acMeshRandomize

(

AcMesh *

mesh

)

acMeshSet()

AcResult acMeshSet	(	const AcReal	value,
		AcMesh *	mesh
	)

acModelIntegrateStep()

AcResult acModelIntegrateStep	(	AcMesh	mesh,
		const AcReal	dt
	)

acUpdateBuiltinParams()

AcResult acUpdateBuiltinParams

(

AcMeshInfo *

config

)

Updates the built-in parameters based on nx, ny and nz

acVerifyMesh()

AcResult acVerifyMesh	(	const AcMesh	model,
		const AcMesh	candidate
	)

Returns true when successful, false if errors were found.