api/aspherix.h

This is the main header file which gives you access to the input functions executeInputFile and executeCommand and all other Aspherix® objects. The public member functions of the class are:

Aspherix 

constructor in three different flavours for running serial and with MPI.

executeInputFile 

runs an input script

executeCommand 

runs a single command

createFix 

creates a LIGGGHTS® style fix

getParticleList 

gets a list of all particles in the simulation (see api/aspherix_particle_list.h)

getGlobalProperties 

gets a list of all global properties defined so far (see api/aspherix_global_properties.h)

getFix 

gets a fix (see api/aspherix_fix.h)

getVariable 

gets a variable (see api/aspherix_variable.h)

getMesh 

gets a mesh (see api/aspherix_mesh.h)

getMeshList 

gets list of all meshes (see api/aspherix_mesh.h)

registerFixExternal 

registers a fix that is defined by you (see api/aspherix_fix_external.h)

registerContactModelExternal 

register a custom contact model implemented by you (see api/aspherix_contact_model_external.h)

unregisterFixExternal 

remove a custom API fix

unregisterContactModelExternal 

remove a custom API contact model