This is a list of Elle functions. It is not complete, and some functions may be out of date. But it is still very useful.<\/p>\n
<\/p>\n
1\u00a0 Initialisation functions<\/strong><\/p>\n ElleInit ElleReinit 2\u00a0 Update and display functions<\/strong><\/p>\n ElleUpdateDisplay 3\u00a0 Topology functions<\/strong><\/p>\n ElleCrossingsCheck ElleCheckDoubleJ ElleCheckTripleJ 4\u00a0 File functions<\/strong><\/p>\n ElleReadData ElleWriteData ElleAutoWriteFile 5\u00a0 Flynn functions<\/strong><\/p>\n ElleAddFlynnChild ElleCheckFlynnDefaults ElleCleanFlynnArray ElleDefaultFlynnRealAttrib ElleFindFlynnMinArea ElleFindSpareFlynn ElleFlynnAttributeActive ElleFlynnDfltAttributeList ElleFlynnHasAttribute ElleFlynnIsActive ElleFlynnNbRegions ElleFlynnNodeCount ElleFlynnNodes ElleGetFlynnCAxis, ElleGetFlynnEuler3 ElleGetFlynnIntAttribute ElleGetFlynnRealAttribute ElleInitFlynnAttribute ElleMaxFlynns ElleMergeFlynns Input:\u00a0\u00a0\u00a0 index\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn. ElleMergeFlynnsNoCheck ElleNucleateFlynnFromNode ElleNumberOfGrains ElleNumFlynnAttributes<\/p>\n EllePromoteFlynn ElleRemoveFlynn ElleRemoveFlynnAttribute ElleSetDefaultFlynnRealAttrib ElleSetFlynnActive ElleSetFlynnCAxis, ElleSetFlynnEuler3 ElleSetFlynnFirstNode ElleSetFlynnIntAttribute ElleSetFlynnRealAttribute ElleSplitFlynn ElleSplitFlynnandPromote ElleSplitFlynnChildrenOnArea ElleSplitFlynnOnArea ElleSplitFlynnOnArea ElleSplitWrappingFlynn ElleWriteFlynnPolyFile ElleWriteParentFlynn hasParent isChildOf isFlynnIntegerAttribute isParent 6\u00a0 Node functions<\/strong><\/p>\n ElleAddDoubles ElleCopyToPosition ElleCopyToPrevPosition ElleDeleteDoubleJ ElleFindSpareNode ElleInitNodeAttribute ElleInsertDoubleJ ElleIntrpAttributes ElleMaxNodeAttributes ElleMaxNodes ElleNeighbourNodes ElleNeighbourRegion ElleNodeAttribute ElleNodeAttributeList ElleNodeIsActive ElleNodeIsDouble ElleNodeIsTriple ElleNodeNumAttributes ElleNodeOnRgnBnd ElleNodePlotXY ElleNodePosition ElleNodePrevPosition ElleNodeSeparation ElleNodeUnitXY ElleNumberOfNodes ElleRegions ElleRelPosition ElleSetNodeActive ElleSetNodeAttribute ElleSetPosition ElleSetPrevPosition ElleSwitchTripleNodes ElleSwitchTriples ElleTotalNodeMass ElleUpdatePosition 7\u00a0\u00a0\u00a0 \u00a0Unode Functions<\/strong><\/p>\n ElleGetFlynnUnodeList ElleGetUnodeAttribute ElleGetUnodePosition ElleInitUnodeAttribute ElleInitUnodes ElleMaxUnodes ElleSetUnodeAttribute ElleTotalUnodeMass ElleUnodeAttributeActive ElleUnodeROI ElleUnodesActive 8\u00a0 Triangulation functions<\/strong><\/p>\n TriangulateUnodes TriangulateUnodes ElleClearTriAttributes ElleGetTriPtNeighbours ElleGetNodeTriPtNeighbours EllePlotTriangles 9\u00a0 Runtime settings<\/strong><\/p>\n ElleSetSaveFileRoot ElleSetSaveFrequency ElleSetVerbose ElleSetDisplay ElleSetStages ElleSetInitFunction ElleInitFunction ElleSetRunFunction ElleRunFunction ElleSetExitFunction ElleExitFunction ElleSetFile ElleFile ElleSetSwitchdistance ElleSwitchdistance ElleSetSpeedup ElleSpeedup EllemaxNodeSep ElleminNodeSep ElleReadOptionData ElleWriteOptionData ElleSaveFileRoot EllemaxStages ElleDisplay ElleTemperature EllePressure ElleBoundaryWidth ElleUnitLength ElleSetUnitLength ElleSetBoundaryWidth ElleSetPressure ElleSetTemperature ElleSetCellBBox ElleCellBBox Last Updated on Monday, 21 April 2008 11:30 <\/span><\/p>\n","protected":false},"excerpt":{"rendered":" This is a list of Elle functions. It is not complete, and some functions may be out of date. But it is still very useful. 1\u00a0 Initialisation functions ElleInit Synopsis:\u00a0\u00a0\u00a0 #include \u201cinit.h\u201d int ElleInit() Description:\u00a0\u00a0\u00a0 Initialises the Elle data structures. This function must be called at the beginning of an Elle process. Returns: \u00a0\u00a0\u00a0 […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":59,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-69","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.ub.edu\/elle\/wp-json\/wp\/v2\/pages\/69","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.ub.edu\/elle\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.ub.edu\/elle\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.ub.edu\/elle\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.ub.edu\/elle\/wp-json\/wp\/v2\/comments?post=69"}],"version-history":[{"count":1,"href":"https:\/\/www.ub.edu\/elle\/wp-json\/wp\/v2\/pages\/69\/revisions"}],"predecessor-version":[{"id":70,"href":"https:\/\/www.ub.edu\/elle\/wp-json\/wp\/v2\/pages\/69\/revisions\/70"}],"up":[{"embeddable":true,"href":"https:\/\/www.ub.edu\/elle\/wp-json\/wp\/v2\/pages\/59"}],"wp:attachment":[{"href":"https:\/\/www.ub.edu\/elle\/wp-json\/wp\/v2\/media?parent=69"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinit.h\u201d
\nint ElleInit()
\nDescription:\u00a0\u00a0\u00a0 Initialises the Elle data structures. This function must be called at the beginning of an Elle process.
\nReturns: \u00a0\u00a0\u00a0 0 if successful( failure will cause the program to exit).<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinit.h\u201d
\nint ElleReinit()
\nDescription:\u00a0\u00a0\u00a0 Reinitialises data arrays and deletes attribute lists so that a new file can be read or a run restarted.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include “display.h”
\nvoid ElleUpdateDisplay()
\nDescription:\u00a0\u00a0\u00a0 Updates the graphical display of the microstructure, using the settings shown in the Display->Set Options menu.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include “crossings.h”
\nint ElleCrossingsCheck(int node, Coords *pos_incr);
\nDescription:\u00a0\u00a0\u00a0 Determines whether boundary crossings result if the node is moved according to the data in pos_incr. If crossings are found the topology is altered to remove them.
\nInput:\u00a0\u00a0\u00a0 node\u00a0\u00a0\u00a0 Specifies the node to move.
\npos_incr\u00a0\u00a0\u00a0 The distance and direction to move.
\nReturns:\u00a0\u00a0\u00a0 0.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include “check.h”
\nint ElleCheckDoubleJ(int node)
\nDescription:\u00a0\u00a0\u00a0 If the node is more than ElleMaxNodeDistance() from a neighbour, a new double node is inserted halfway along that boundary. If the node is less than ElleMinNodeDistance() from a neighbour, the node itself is deleted.
\nInput:\u00a0\u00a0\u00a0 node\u00a0\u00a0\u00a0 Specifies the node to be checked.
\nReturns:\u00a0\u00a0\u00a0 0 if successful, else non-zero error number.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201ccheck.h\u201d
\nint ElleCheckTripleJ(int node)
\nDescription:\u00a0\u00a0\u00a0 If the node is more than ElleMaxNodeDistance() from a neighbour, a new double node is inserted halfway along that boundary. If the node is less than ElleMinNodeDistance() from a triple junction neighbour, a \u201ctriple switch\u201d is carried out.
\nInput:\u00a0\u00a0\u00a0 node\u00a0\u00a0\u00a0 Specifies the node to be checked.
\nReturns:\u00a0\u00a0\u00a0 0 if successful or a non-zero error number.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include “file.h”
\nint ElleReadData(char *filename);
\nDescription:\u00a0\u00a0\u00a0 Reads the Elle data from filename.
\nInput:\u00a0\u00a0\u00a0 filename\u00a0\u00a0\u00a0 The name of the file to be read (may include path).
\nReturns:\u00a0\u00a0\u00a0 0 if successful else non-zero error number.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cfile.h\u201d
\nint ElleWriteData(char *filename)
\nDescription:\u00a0\u00a0\u00a0 Writes the current Elle data to filename.
\nInput:\u00a0\u00a0\u00a0 filename\u00a0\u00a0\u00a0 The name of the file to be written (may include path).
\nReturns:\u00a0\u00a0\u00a0 0 if successful else non-zero error number.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cfile.h\u201d
\nint ElleAutoWriteFile(int cnt)
\nDescription:\u00a0\u00a0\u00a0 Creates a filename from the file \u201croot\u201d and the parameter cnt then calls ElleWriteData, eg if the root is set to test and cnt is 20, this function will call ElleWriteData(\u201ctest020.elle\u201d).
\nInput:\u00a0\u00a0\u00a0 cnt\u00a0\u00a0\u00a0 The number of stages (to be incorporated into the file name).
\nReturns:\u00a0\u00a0\u00a0 0 if successful else non-zero error number.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nint ElleAddFlynnChild(int index, int child)
\nDescription:\u00a0\u00a0\u00a0 Adds an entry to a flynn\u2019s list of children if the child is not already in the list.
\nInput:\u00a0\u00a0\u00a0 index\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the parent flynn.
\nchild\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the new child.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nvoid ElleCheckFlynnDefaults(int id)
\nDescription:\u00a0\u00a0\u00a0 Checks that active flynns, which do not have parents, have a value for this attribute.
\nInput: \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 id\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the attribute.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nvoid ElleCleanFlynnArray()
\nDescription:\u00a0\u00a0\u00a0 Reinitialize all the flynns ie all inactive.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\ndouble ElleDefaultFlynnRealAttribute(int id)
\nDescription:\u00a0\u00a0\u00a0 The above functions return the default value for the flynn attribute.
\nReturns:\u00a0\u00a0\u00a0 The attribute value. The variable holding the return value should be of the correct type for the attribute.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\ndouble ElleFindFlynnMinArea(int flynnindex)
\nDescription:\u00a0\u00a0\u00a0 Retrieves the minimum area from the mineral database if the MINERAL attribute is active, else gets the global minimum flynn area value.
\nInput:\u00a0\u00a0\u00a0 flynnindex\u00a0\u00a0\u00a0 Specifies the flynn
\nReturns:\u00a0\u00a0\u00a0 the minimum flynn area.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nint ElleFindSpareFlynn()
\nDescription:\u00a0\u00a0\u00a0 Searches the flynns (low to high index) to find an inactive one.
\nReturns:\u00a0\u00a0\u00a0 The index of an inactive flynn.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nunsigned char ElleFlynnAttributeActive(int id)
\nDescription:\u00a0\u00a0\u00a0 Determines whether the specified flynn attribute is active.
\nInput:\u00a0\u00a0\u00a0 id\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the attribute.
\nReturns:\u00a0\u00a0\u00a0 1 if active, else 0.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nvoid ElleFlynnDfltAttributeList(int **active, int *maxa)
\nDescription:\u00a0\u00a0\u00a0 Creates a list of the currently active flynn attributes. Memory is allocated for the array and should be released when no longer needed.
\nOutput:\u00a0\u00a0\u00a0 active \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Array of attributes identifiers (see flynn attributes).
\nmaxa\u00a0\u00a0\u00a0 \u00a0The size of the array.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nunsigned char ElleFlynnHasAttribute(int index,int id)
\nDescription:\u00a0\u00a0\u00a0 Determines whether the specified flynn has the attribute in its list (i.e. it has no parent or the value of the attribute differs from that of its parent).
\nInput:\u00a0\u00a0\u00a0 index\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn.
\nid\u00a0\u00a0\u00a0 \u00a0Specifies the attribute.
\nReturns:\u00a0\u00a0\u00a0 1 if the attribute is found, else 0.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nunsigned char ElleFlynnIsActive(int index)
\nDescription:\u00a0\u00a0\u00a0 Finds the state of a flynn.
\nInputs: \u00a0\u00a0\u00a0 index \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn.
\nReturns: \u00a0\u00a0\u00a0 True if the flynn is active else false.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nvoid FlynnNbRegions(int index, list<int> &nbflynns)
\nDescription:\u00a0\u00a0\u00a0 Creates a list of the flynns which share a boundary with the specified flynn. The flynns are ordered by the number of segments in the shared boundary, high to low.
\nInput:\u00a0\u00a0\u00a0 index\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn.
\nnbflynns\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 The list of neighbouring regions.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nint ElleFlynnNodeCount(int index)
\nDescription:\u00a0\u00a0\u00a0 Finds the number of nodes on the flynn boundary (ie\u00a0 num in ElleFlynnNodes).
\nInput:\u00a0\u00a0\u00a0 index\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn.
\nReturns:\u00a0\u00a0\u00a0 The number of boundary nodes.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nvoid ElleFlynnNodes(int index, int **ids, int *num)
\nDescription:\u00a0\u00a0\u00a0 Finds the boundary nodes of a flynn. *num is set to the number of nodes. Ids is the list of node numbers and is allocated storage by a call to malloc(). A call to free(ids) must be made when the information is no longer required.
\nInput:\u00a0\u00a0\u00a0 index\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn.
\nOutput:\u00a0\u00a0\u00a0 ids\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Is set to the address of storage for the list of nodes.
\nnum\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Is set to the number of nodes in the list.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nvoid ElleGetFlynnCAxis(int index, Coords_3D *valptr)
\nvoid ElleGetFlynnEuler3(int index, double *alpha, double *beta, double *gamma)
\nDescription:\u00a0\u00a0\u00a0 The above functions get the value of a flynn attribute. If the attribute is not active or the flynn does not have the attribute the program will terminate. Always check using the functions ElleFlynnAttributeActive and ElleFlynnHasAttribute
\nInput:\u00a0\u00a0\u00a0 index\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn.
\nOutput:\u00a0\u00a0\u00a0 The attribute value. The variable holding the return value should be of the correct type for the attribute.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nvoid ElleGetFlynnIntAttribute(int index, int *valptr, int id)
\nDescription:\u00a0\u00a0\u00a0 This function gets the value of an integer flynn attribute. If the attribute is not active or the flynn does not have the attribute the program will terminate. Always check using the functions ElleFlynnAttributeActive and ElleFlynnHasAttribute ElleGetFlynnIntAttribute accepts only integer attributes as the third parameter (see the section on Flynn Attributes).
\nInput:\u00a0\u00a0\u00a0 index\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn.
\nid\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the attribute
\nOutput:\u00a0\u00a0\u00a0 The attribute value. The variable holding the return value, valptr, should be of type integer.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nvoid ElleGetFlynnRealAttribute(int index, double *valptr, int id)
\nDescription:\u00a0\u00a0\u00a0 This function gets the value of a real flynn attribute. If the attribute is not active or the flynn does not have the attribute the program will terminate. Always check using the functions ElleFlynnAttributeActive and ElleFlynnHasAttribute ElleGetFlynnIntAttribute accepts only real attributes as the third parameter (see the section on Flynn Attributes).
\nInput:\u00a0\u00a0\u00a0 index\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn.
\nid\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the attribute
\nOutput:\u00a0\u00a0\u00a0 The attribute value. valptr should be the address of a variable of type double.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nvoid ElleInitFlynnAttribute(int id)
\nDescription:\u00a0\u00a0\u00a0 The attribute is added to the list of active attributes. Active flynns which do not have parents are given the default value for this attribute. If the attribute is already active, nothing is done.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 id\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the attribute.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nint ElleMaxFlynns()
\nDescription:\u00a0\u00a0\u00a0 Finds the total number of flynns, both active and inactive. This function is used when looping over the flynn array.
\nReturns: \u00a0\u00a0\u00a0 The number of flynns.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nint ElleMergeFlynns(int keepflynn, int removeflynn)
\nDescription:\u00a0\u00a0\u00a0 Merges the second flynn into the first by removing the longest common boundary. The merge will only be carried out if the flynns are both on the lowest level, have the same parent (or no parent) and have the same values for their integer attributes.<\/p>\n
\nmaxarea\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 The maximum flynn area limit.
\nReturns:\u00a0\u00a0\u00a0 1 if the flynns are merged, else 0.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nint ElleMergeFlynnsNoCheck(int keepflynn, int removeflynn)
\nDescription:\u00a0\u00a0\u00a0 Merges the second flynn into the first by removing the longest common boundary. The merge is forced with no checks. Only used for removing tiny flynns
\nInput:\u00a0\u00a0\u00a0 keepflynn\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn to survive the merge.
\nremoveflynn\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn to be removed.
\nReturns:\u00a0\u00a0\u00a0 1 if the flynns are merged, else 0.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nvoid ElleNucleateFlynnFromNode(int node, int *new)
\nDescription:\u00a0\u00a0\u00a0 Creates a new flynn around the node by adding double nodes on the boundaries and joining these new nodes. The position of the original node is changed. The variable new returns\u00a0 the index of the new flynn.
\nInput:\u00a0\u00a0\u00a0 node\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the node.
\nOutput:\u00a0\u00a0\u00a0 new\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the new flynn.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nint ElleNumberOfGrains()
\nDescription:\u00a0\u00a0\u00a0 Counts the number of active flynns. This functions is used by the statistics routine for a microstructure without parent flynns (single level)
\nReturns:\u00a0\u00a0\u00a0 The number of active flynns.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nvoid EllePromoteFlynn(int flynnindex)
\nDescription:\u00a0\u00a0\u00a0 Raise the flynn one level in the hierarchy.
\nInput:\u00a0\u00a0\u00a0 flynnindex\u00a0\u00a0\u00a0 Specifies the flynn to be promoted.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nvoid ElleRemoveFlynn(int flynnindex)
\nDescription:\u00a0\u00a0\u00a0 Makes a flynn inactive after removing it from the hierarchy. Assumes the attributes have been removed.
\nInput:\u00a0\u00a0\u00a0 flynnindex\u00a0\u00a0\u00a0 Specifies the flynn to be removed.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nvoid ElleRemoveFlynnAttribute(int index, int idval)
\nDescription:\u00a0\u00a0\u00a0 Removes the attribute from the flynn\u2019s attribute list. No action if the attribute is not in the list of the specified flynn.
\nInput:\u00a0\u00a0\u00a0 index\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn.
\nidval\u00a0\u00a0\u00a0 \u00a0Specifies the attribute.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nvoid ElleSetDefaultFlynnRealAttrib(double val,int id)
\nDescription:\u00a0\u00a0\u00a0 Set the default value for a flynn attribute. Commonly called when the \u201cDefault\u201d keyword occurs in an Elle file. Could also be used if a new attribute is initialised in a program and the program default value needs to be overridden.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 The value should be the correct type for the attribute.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nint ElleSetFlynnActive(int index)
\nDescription:\u00a0\u00a0\u00a0 Makes a flynn active.
\nInputs: \u00a0\u00a0\u00a0 index \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn to be flagged as active.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nvoid ElleSetFlynnCAxis(int index, Coords_3D *val)
\nvoid ElleSetFlynnEuler3(int index, double alpha, double beta, double gamma)
\nDescription:\u00a0\u00a0\u00a0 The above functions set the value of a flynn attribute. If the attribute is not active or the flynn does not have the attribute the program will terminate. Always check using the functions ElleFlynnAttributeActive and ElleFlynnHasAttribute.
\nInput:\u00a0\u00a0\u00a0 The attribute value(s). The variables should be of the correct number and type for the attribute.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nvoid ElleSetFlynnFirstNode(int index, int first)
\nDescription:\u00a0\u00a0\u00a0 Sets the value of the flynn\u2019s first node (used to walk around the flynn).
\nInputs:\u00a0\u00a0\u00a0 index\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn.
\nfirst\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 The node number of the first node.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nvoid ElleSetFlynnIntAttribute(int index, int val, int id)
\nDescription:\u00a0\u00a0\u00a0 This function sets the value of an integer flynn attribute. If the attribute is not active or the flynn does not have the attribute the program will terminate. Always check using the functions ElleFlynnAttributeActive and ElleFlynnHasAttribute. ElleSetFlynnIntAttribute accepts only integer attributes as the third parameter (see the section on Flynn Attributes).
\nInput:\u00a0\u00a0\u00a0 index\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn.
\nval\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 The value for the attribute
\nid\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the attribute<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nvoid ElleSetFlynnRealAttribute(int index, double val, int id)
\nDescription:\u00a0\u00a0\u00a0 This function sets the value of a flynn attribute. If the attribute is not active or the flynn does not have the attribute the program will terminate. Always check using the functions ElleFlynnAttributeActive and ElleFlynnHasAttribute. ElleSetFlynnRealAttribute accepts only real attributes as the third parameter (see the section on Flynn Attributes).
\nInput:\u00a0\u00a0\u00a0 index\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn.
\nval\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 The value for the attribute
\nid\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the attribute<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nint ElleSplitFlynn(int index, int *child1, int *child2)
\nDescription:\u00a0\u00a0\u00a0 Splits a flynn into 2 sub flynns by a random walk. The new flynns are children of the original flynn.
\nInput:\u00a0\u00a0\u00a0 index\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn.
\nOuput:\u00a0\u00a0\u00a0 child1, child2\u00a0\u00a0\u00a0 Are set to the indices of the new flynns.
\nReturns:\u00a0\u00a0\u00a0 0 if successful, else > 0.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nint ElleSplitFlynnandPromote(int index, int *c1, int *c2)
\nDescription:\u00a0\u00a0\u00a0 Splits a flynn into 2 sub flynns by a random walk. The new flynns are given the attributes of the original flynn which is then deleted.
\nInput:\u00a0\u00a0\u00a0 index\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn.
\nOuput:\u00a0\u00a0\u00a0 c1, c2 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Are set to the indices of the new flynns.
\nReturns:\u00a0\u00a0\u00a0 1 if successful, else 0.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nvoid ElleSplitFlynnChildrenOnArea(int index, double maxarea)
\nDescription:\u00a0\u00a0\u00a0 Attempts to split each child of a flynn by calling ElleSplitFlynnOnArea.
\nInput:\u00a0\u00a0\u00a0 index\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn.
\nmaxarea\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 The maximum flynn area limit.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nvoid ElleSplitFlynnOnArea(int type, int index, double dx, double dy)
\nDescription:\u00a0\u00a0\u00a0 Attempts to split a flynn by recursively calling ElleSplitFlynnandPromote until all the new flynns have an area smaller than that set in the mineral database, if MINERAL attribute is active, or the global setting. dx, dy are used to control the direction of the split. If dx=dy=0, the function will generate a random vector to follow otherwise the flynn will be split in the direction specified by these parameters.\u00a0 The function will try the boundary nodes in turn until it can split the flynn in the specified direction with both new flynns having an area greater then the minimum area. The minimum area is taken from the mineral database, if MINERAL attribute is set, or from the global setting (see ElleSetFlynnMinArea())
\nInput:\u00a0\u00a0\u00a0 type\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 type of walk, random (type=RANDOM) or directed (type=DIRECT)
\nindex\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn.
\ndx, dy\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specify the walk direction<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nvoid ElleSplitFlynnOnArea(int type, int index, double maxarea, double dx, double dy)
\nDescription:\u00a0\u00a0\u00a0 Attempts to split a flynn by recursively calling ElleSplitFlynnandPromote until all the new flynns have an area smaller than the specified limit. dx, dy are used to control the direction of the split. If dx=dy=0, the function will generate a random vector to follow otherwise the flynn will be split in the direction specified by these parameters.\u00a0 The function will try the boundary nodes in turn until it can split the flynn in the specified direction with both new flynns having an area greater then the minimum area. The minimum area is taken from the mineral database, if MINERAL attribute is set, or from the global setting (see ElleSetFlynnMinArea())
\nInput:\u00a0\u00a0\u00a0 type\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 type of walk, random (type=RANDOM) or directed (type=DIRECT)
\nindex\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn.
\nmaxarea\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 The maximum flynn area limit.
\ndx, dy\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specify the walk direction<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nint ElleSplitWrappingFlynn(int index, int node1, int node2, int *child1, int *child2)
\nDescription:\u00a0\u00a0\u00a0 Splits a flynn into 2 sub flynns by a random walk starting on the shortest path from node1 to node2. The new flynns are given the attributes of the original flynn which is then deleted.
\nInput:\u00a0\u00a0\u00a0 index\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn.
\nOuput:\u00a0\u00a0\u00a0 child1, child2\u00a0\u00a0\u00a0 Are set to the indices of the new flynns.
\nReturns:\u00a0\u00a0\u00a0 0 if successful, else > 0.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nint ElleWriteFlynnPolyFile(int flynnid, char *fname)
\nDescription:\u00a0\u00a0\u00a0 Writes the flynn nodes in poly file format to the file, fname. The node identifier is the last entry on the line. The file can be viewed with Triangle\u2019s showme utility
\nInput:\u00a0\u00a0\u00a0 flynnid\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn.
\nfname\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 The output filename.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nint ElleWriteParentFlynn(int index, FILE *fp)
\nDescription:\u00a0\u00a0\u00a0 Used to write the list of child flynn numbers to an Elle file.
\nInput:\u00a0\u00a0\u00a0 index\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the parent flynn.
\nfp\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Pointer to the FILE structure of the output file.
\nReturns:\u00a0\u00a0\u00a0 0 if successful, non-zero error number on failure.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nunsigned char hasParent(int flynn1)
\nDescription:\u00a0\u00a0\u00a0 Finds whether the flynn has a parent (is a child).
\nInput:\u00a0\u00a0\u00a0 flynn1\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn.
\nReturns:\u00a0\u00a0\u00a0 True if flynn1 has a parent, else false.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nunsigned char isChildOf(int flynn1,int flynn2)
\nDescription:\u00a0\u00a0\u00a0 Finds whether flynn1 is a sub-region of flynn2.
\nInput:\u00a0\u00a0\u00a0 flynn1\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the child flynn.
\nflynn2\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the parent flynn.
\nReturns:\u00a0\u00a0\u00a0 True if flynn1 is a descendant of flynn2, else false.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nunsigned char isFlynnIntegerAttribute(int attribid)
\nDescription:\u00a0\u00a0\u00a0 Finds whether the attribute is one that store discrete values e.g. MINERAL. This type of attribute must have the same value for flynns to merge (see 3.1.1).
\nInput:\u00a0\u00a0\u00a0 attribid\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the attribute.
\nReturns:\u00a0\u00a0\u00a0 True if attribid is an attribute that represents integer values<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nunsigned char isParent(int flynn1)
\nDescription:\u00a0\u00a0\u00a0 Finds whether the flynn is a parent (has at least one child).
\nInput:\u00a0\u00a0\u00a0 flynn1\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the flynn.
\nReturns:\u00a0\u00a0\u00a0 True if flynn1 is a parent, else false.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nint ElleAddDoubles()
\nDescription:\u00a0\u00a0\u00a0 Inserts new double nodes (see ElleInsertDoubleJ) halfway along segments which are longer than the maximum node separation. The active nodes are checked until no new nodes need to be added.
\nReturns: \u00a0\u00a0\u00a0 0.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nvoid ElleCopyToPosition(int node, Coords *position)
\nDescription:\u00a0\u00a0\u00a0 Sets the new node location without translating into the unit cell. The previous position is updated.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 node\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the node.
\nposition\u00a0\u00a0\u00a0 Points to a structure holding the new position.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nvoid ElleCopyToPrevPosition(int node, Coords *position)
\nDescription:\u00a0\u00a0\u00a0 Sets the previous node location without translating into the unit cell.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 node\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the node.
\nposition\u00a0\u00a0\u00a0 Points to a structure holding the new values.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nint ElleDeleteDoubleJ(int id)
\nDescription:\u00a0\u00a0\u00a0 Deletes the specified node.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 id\u00a0\u00a0\u00a0 Specifies the index of the node to be deleted.
\nReturns: \u00a0\u00a0\u00a0 0 (topological inconsistencies cause the program to exit).<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nint ElleFindSpareNode()
\nDescription:\u00a0\u00a0\u00a0 Searches the node array for the first inactive entry (allocates a larger array if all entries are active).
\nReturns:\u00a0\u00a0\u00a0 The index of an inactive entry.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nvoid ElleInitNodeAttribute(int id)
\nDescription:\u00a0\u00a0\u00a0 Activates a node attribute.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 id\u00a0\u00a0\u00a0 Specifies the attribute (see node attribute values).<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nint ElleInsertDoubleJ(int node1,int node2,int *nn,float frac)
\nDescription:\u00a0\u00a0\u00a0 Inserts a new double node between two neighbouring nodes and gives it attributes interpolated linearly from the neighbours.
\nInput:\u00a0\u00a0\u00a0 node1, node2\u00a0\u00a0\u00a0 The nodes to be separated by the new node.
\nfrac\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Determines the distance along the segment (from node1) to locate the new node.
\nOutput:\u00a0\u00a0\u00a0 nn\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 This will be set to the index of the new node.
\nReturns:\u00a0\u00a0\u00a0 0<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nvoid ElleIntrpAttributes(int n)
\nDescription:\u00a0\u00a0\u00a0 Performs a linear interpolation of active attributes for a new double node (assume triples are not inserted)
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 n\u00a0\u00a0\u00a0 specifies the new node<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nint ElleMaxNodeAttributes()
\nDescription:\u00a0\u00a0\u00a0 Finds the number of node attributes activated.
\nReturns:\u00a0\u00a0\u00a0 Number of node attributes (an active node attribute is assigned to all nodes).<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nint ElleMaxNodes()
\nDescription:\u00a0\u00a0\u00a0 Finds the current size of the node array.
\nReturns:\u00a0\u00a0\u00a0 The total number of entries in the node array, both active and inactive.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nint ElleNeighbourNodes(int node, int *nbnodes)
\nDescription:\u00a0\u00a0\u00a0 Finds the indices of a nodes neighbours
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 node\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the node.
\nOutput:\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 nbnodes\u00a0\u00a0\u00a0 An existing array of 3 integers into which the neighbour indices are copied. If the node is double, the blank entry may be in any position.
\nReturns:\u00a0\u00a0\u00a0 0, if node is inactive the program terminates.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nvoid ElleNeighbourRegion(int node, int nb, ERegion *region)
\nDescription:\u00a0\u00a0\u00a0 Finds the flynn to the left of the node->nb boundary.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 node\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the node.
\nnb\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the boundary.
\nOutput:\u00a0\u00a0\u00a0 region\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Set to the flynn id.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\ndouble ElleNodeAttribute(int node, int id)
\nDescription:\u00a0\u00a0\u00a0 Finds the value of a node attribute.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 node\u00a0\u00a0\u00a0 Specifies the node.
\nid\u00a0\u00a0\u00a0 Specifies the attribute (see node attribute values).
\nReturns:\u00a0\u00a0\u00a0 The value of the attribute (an invalid id will terminate the program).<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nvoid ElleNodeAttributeList(int **active, int *max)
\nDescription:\u00a0\u00a0\u00a0 Creates a list of active node attributes. Memory is allocated for the list so should be released when no longer needed.
\nOutput:\u00a0\u00a0\u00a0 active\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 The address of a pointer to the list of attributes.
\nmax\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Set to the number of attributes.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nint ElleNodeIsActive(int node)
\nDescription:\u00a0\u00a0\u00a0 Finds the state of the specified node.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 node\u00a0\u00a0\u00a0 The specified node.
\nReturns:\u00a0\u00a0\u00a0 If node is valid (<ElleMaxNodes()), returns 1 if active else 0.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nint ElleNodeIsDouble(int node)
\nDescription:\u00a0\u00a0\u00a0 Counts the neighbours of the specified node.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 node\u00a0\u00a0\u00a0 The specified node.
\nReturns:\u00a0\u00a0\u00a0 1 if there are two neighbours, else 0.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nint ElleNodeIsTriple(int node)
\nDescription:\u00a0\u00a0\u00a0 Counts the neighbours of the specified node.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 node\u00a0\u00a0\u00a0 The specified node.
\nReturns:\u00a0\u00a0\u00a0 1 if there are three neighbours, else 0.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nint ElleNodeNumAttributes()
\nDescription:\u00a0\u00a0\u00a0 Counts the number of active node attributes.
\nReturns:\u00a0\u00a0\u00a0 The number of node attributes.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nint ElleNodeOnRgnBnd(int node, ERegion id)
\nDescription:\u00a0\u00a0\u00a0 Determines if the node is on the boundary of the flynn.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 node\u00a0\u00a0\u00a0 Specifies the node.
\nid\u00a0\u00a0\u00a0 An integer specifying the flynn.
\nReturns:\u00a0\u00a0\u00a0 1 if true else 0.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nvoid ElleNodePlotXY(int node, Coords *xy, Coords *prevxy)
\nDescription:\u00a0\u00a0\u00a0 Find the position of a node relative to a given location. This allows for wrapping around the unit cell and the coordinates returned may no be inside the unit cell. One example where this function is used: finding the locations of all nodes on a flynn boundary as the flynn may cross the edge of the unit cell.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 node\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the node.
\nprevxy\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 The node position will be given relative to this location.
\nOutput:\u00a0\u00a0\u00a0 xy\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 The node position.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nvoid ElleNodePosition(int node, Coords *position)
\nDescription:\u00a0\u00a0\u00a0 Finds the node location
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 node\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the node.
\nOutput:\u00a0\u00a0\u00a0 position\u00a0\u00a0\u00a0 Set to the node\u2019s location.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nvoid ElleNodePrevPosition(int node, Coords *previous)
\nDescription:\u00a0\u00a0\u00a0 Finds the node\u2019s previous location.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 node\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the node.
\nOutput:\u00a0\u00a0\u00a0 position\u00a0\u00a0\u00a0 Set to the node\u2019s previous location.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\ndouble ElleNodeSeparation(int node1, int node2)
\nDescription:\u00a0\u00a0\u00a0 Calculates the absolute distance between 2 nodes using the position of node2 relative to node1 (not the unit cell location).
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 node1, node2\u00a0\u00a0\u00a0 The 2 nodes.
\nReturns:\u00a0\u00a0\u00a0 The distance between the nodes.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nvoid ElleNodeUnitXY(Coords *xy)
\nDescription:\u00a0\u00a0\u00a0 Converts x, y coordinates to unit cell coordinates.
\nInput\/Output:\u00a0\u00a0\u00a0 xy\u00a0\u00a0\u00a0 x and y values in a Coords structure.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nvoid ElleNumberOfNodes(int *doubles, int *triples)
\nDescription:\u00a0\u00a0\u00a0 Counts the number of currently active nodes.
\nOutput:\u00a0\u00a0\u00a0 doubles\u00a0\u00a0\u00a0 Set to the number of active double nodes.
\nTriples\u00a0\u00a0\u00a0 Set to the number of active triple nodes.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nint ElleRegions(int node, ERegion *rgn)
\nDescription:\u00a0\u00a0\u00a0 Finds the flynns to the left of each segment (neighbour boundary).
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 node\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the node.
\nOutput:\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 rgn\u00a0\u00a0\u00a0 An array of 3 integers into which the flynn indices are copied. If the node is double, the blank entry may be in any position.
\nReturns:\u00a0\u00a0\u00a0 0, if node is inactive the program terminates.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nvoid ElleRelPosition(Coords *orig, int nb, Coords *xyrel, double *sep)
\nDescription:\u00a0\u00a0\u00a0 Finds the node location relative to a specified point and calculates the distance from this new origin. The relative location may not be within the unit cell.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 orig\u00a0\u00a0\u00a0 x,y coordinates of the new origin.
\nnb\u00a0\u00a0\u00a0 Index of the node.
\nOutput:\u00a0\u00a0\u00a0 xyrel\u00a0\u00a0\u00a0 The recalculated position of nb.
\nsep\u00a0\u00a0\u00a0 The absolute distance from the point (*orig) to nb.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nvoid ElleSetNodeActive(int node)
\nDescription:\u00a0\u00a0\u00a0 Sets the state of the specified node, allocating a larger node array if there are no spare entries.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 node\u00a0\u00a0\u00a0 The index of the node.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nvoid ElleSetNodeAttribute(int node, double val, int id)
\nDescription:\u00a0\u00a0\u00a0 Set the value of a floating point node attribute.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 node\u00a0\u00a0\u00a0 Specifies the node.
\nval\u00a0\u00a0\u00a0 The attribute value.
\nid\u00a0\u00a0\u00a0 Specifies the attribute (see node attribute values).<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nvoid ElleSetPosition(int node, Coords *position)
\nDescription:\u00a0\u00a0\u00a0 Sets the x, y coordinates of the node to the values in the position structure. The position is translated into the unit cell, if necessary. The current position is stored as the previous position before updating.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 node\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 specifies the node
\nposition\u00a0\u00a0\u00a0 points to a structure holding the new position<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nvoid ElleSetPrevPosition(int node, Coords *position)
\nDescription:\u00a0\u00a0\u00a0 Sets the x, y coordinates of the node\u2019s previous position. Normally done automatically to save the last position when a node is moved.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 node\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the node.
\nposition\u00a0\u00a0\u00a0 Points to a structure holding the new values.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nint ElleSwitchTripleNodes(int node1,int node2)
\nDescription:\u00a0\u00a0\u00a0 Perform a triple switch of the specified nodes. The routine assumes they are both triples and will report topological problems if this is not true.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 node1, node2\u00a0\u00a0\u00a0 Specify the nodes to switch.
\nReturns:\u00a0\u00a0\u00a0 0 if successful.
\nNon-zero if it could not resolve a valid topological problem (e.g. a wrapping region which could not be split.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nvoid ElleSwitchTriples(int modfactor)
\nDescription:\u00a0\u00a0\u00a0 Forces switching of neighbouring triple nodes. Used to generate a starting structure from a regular grid.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 modfactor\u00a0\u00a0\u00a0 Specifies how many pairs of triples are switched (modfactor is 6 then every 6th pair is switched).<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\ndouble ElleTotalNodeMass(int attrib_id)
\nDescription:\u00a0\u00a0\u00a0 Find the total mass for concentration attribute
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 attrib_id\u00a0\u00a0\u00a0 Specifies the attribute (assumes the attribute is a concentration).
\nReturns:\u00a0\u00a0\u00a0 the mass for the nodes<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cnodes.h\u201d
\nvoid ElleUpdatePosition(int node, Coords *increment)
\nDescription:\u00a0\u00a0\u00a0 Moves the node by the increment x, y values. It is the same as ElleSetPosition once the new location is calculated but it also updates node and unode concentration attributes.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 node\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the node.
\nIncrement\u00a0\u00a0\u00a0 Specifies the changes to the x, y location.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cinterface.h\u201d
\nvoid ElleGetFlynnUnodeList(int flynn_id, vector<int> &l)
\nDescription:\u00a0\u00a0\u00a0 Find the unconnected nodes that lie inside the flynn specified by flynn_id.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 flynn_id\u00a0\u00a0\u00a0 Specifies the flynn.
\nOutput:\u00a0\u00a0\u00a0 l\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 The list of the unode identifiers.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cunodes.h\u201d
\nvoid ElleGetUnodeAttribute(int id, double *val, const int attrib_id)
\nDescription:\u00a0\u00a0\u00a0 Find the value of the attribute specified by attrib_id for the unconnected node specified by id.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 id\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the unode.
\nattrib_id\u00a0\u00a0\u00a0 The attribute identifier.
\nOutput:\u00a0\u00a0\u00a0 val\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 The value of the specified attribute.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cunodes.h\u201d
\nvoid ElleGetUnodePosition(int id, Coords *xy)
\nDescription:\u00a0\u00a0\u00a0 Find the position of the unconnected node specified by id.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 id\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the unode.
\nOutput:\u00a0\u00a0\u00a0 xy\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 The position of the unode.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cunodes.h\u201d
\nvoid ElleInitUnodeAttribute(int id)
\nDescription:\u00a0\u00a0\u00a0 This attribute will become active for all unodes. All unodes will have the default value of this attribute unless the value is changed using ElleSetUnodeAttribute
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 id\u00a0\u00a0\u00a0 specifies the attribute<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cunodes.h\u201d
\nint ElleInitUnodes(int num_per_row)
\nDescription:\u00a0\u00a0\u00a0 Create unodes, arranged in the unit cell such that a unode is equidistant from its neighbours
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 num_per_row\u00a0\u00a0\u00a0 number of unodes in a row (preferably a multiple of 15)
\nReturns:\u00a0\u00a0\u00a0 0<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cunodes.h\u201d
\nint ElleMaxUnodes()
\nDescription:\u00a0\u00a0\u00a0 Find the number of active unodes
\nReturns:\u00a0\u00a0\u00a0 the maximum index for the unconnected nodes<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cunodes.h\u201d
\nvoid ElleSetUnodeAttribute(int id, double val, const int attrib_id)
\nDescription:\u00a0\u00a0\u00a0 Set the value of the attribute specified by attrib_id for the unconnected node specified by id.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 id\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the unode.
\nattrib_id\u00a0\u00a0\u00a0 The attribute identifier.
\nval\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Set to the value of the specified attribute.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cunodes.h\u201d
\ndouble ElleTotalUnodeMass(int attrib_id)
\nDescription:\u00a0\u00a0\u00a0 Find the total mass for concentration attribute
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 attrib_id\u00a0\u00a0\u00a0 Specifies the attribute (assumes the attribute is a concentration).
\nReturns:\u00a0\u00a0\u00a0 the mass for the unconnected nodes<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cunodes.h\u201d
\nunsigned char ElleUnodeAttributeActive(int id)
\nDescription:\u00a0\u00a0\u00a0 Find whether the attribute is active
\nReturns:\u00a0\u00a0\u00a0 1, if the attribute is active, else 0<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cunodes.h\u201d
\ndouble ElleUnodeROI()
\nDescription:\u00a0\u00a0\u00a0 The ROI is twice the spacing between unodes (see 4.2.2)
\nReturns:\u00a0\u00a0\u00a0 the radius of the region of interest for an unconnected node<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cunodes.h\u201d
\nint ElleUnodesActive()
\nDescription:\u00a0\u00a0\u00a0 Test whether unconnected nodes have been initialised for this experiment
\nReturns:\u00a0\u00a0\u00a0 1, if unconnected nodes are active, else 0<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cunodes.h\u201d
\nvoid TriangulateUnodes(int flynn_id, struct triangulateio *out)
\nDescription:\u00a0\u00a0\u00a0 Triangulate the unconnected nodes within a flynn with its boundary nodes. No new nodes are inserted on the flynn boundary. The triangle attribute is calculated from the unode values for the attr parameter and node margin values, if active.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 flynn_id\u00a0\u00a0\u00a0 Specifies the flynn.
\nout\u00a0\u00a0\u00a0 pointer to a triangulateio structure. This should be Mesh.tri if the functions in triattrib.h are to be used (See 3.5).
\nattr\u00a0\u00a0\u00a0 specifies the triangle attribute to be calculated
\nReturns:\u00a0\u00a0\u00a0 1, if unconnected nodes are active, else 0<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cunodes.h\u201d
\nvoid TriangulateUnodes(int flynn_id, struct triangulateio *out)
\nDescription:\u00a0\u00a0\u00a0 Triangulate the unconnected nodes within a flynn and its boundary nodes. No new nodes are inserted on the flynn boundary. The triangle attribute will be calculated from the CONC_A values of the unodes and the margin values (N_MCONC_A) at the nodes, if active. It is equivalent to TriangulateUnodes(Flynn_id,out,CONC_A)
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 flynn_id\u00a0\u00a0\u00a0 Specifies the flynn.
\nout\u00a0\u00a0\u00a0 pointer to a triangulateio structure. This should be Mesh.tri if the functions in triattrib.h are to be used (see 8).
\nReturns:\u00a0\u00a0\u00a0 1, if unconnected nodes are active, else 0<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201ctriattrib.h\u201d
\nvoid ElleClearTriAttributes()
\nDescription:\u00a0\u00a0\u00a0 Clear the attributes from Mesh<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201ctriattrib.h\u201d
\nvoid ElleGetTriPtNeighbours(int index, vector<int> &nbnodes,
\nunsigned char bnd)
\nDescription:\u00a0\u00a0\u00a0 Puts the Elle identifiers of the triangulation neighbours in nbnodes. If bnd is set to 1 then all neighbours are included. If bnd is zero, only the non-boundary neighbours are listed. The neighbours are listed in anticlockwise order.
\nInput:\u00a0\u00a0\u00a0 index\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the Elle unode identifier of the triangulation point.
\nbnd\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 0, do not include flynn boundary nodes
\n1, include flynn boundary nodes
\nOutput:\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 nbnodes\u00a0\u00a0\u00a0 The list of nodes connected to the triangulation point with the Elle identifier, index.
\non_bnd\u00a0\u00a0\u00a0 corresponds to nbnodes, 0 for a unode, 1 for a boundary node<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201ctriattrib.h\u201d
\nvoid ElleGetNodeTriPtNeighbours(int index, vector<int> &nbnodes,
\nvector<int> &on_bnd, int nb_id,
\nunsigned char bnd)
\nDescription:\u00a0\u00a0\u00a0 Puts the Elle identifiers of the triangulation neighbours in nbnodes. If bnd is set to 1 then all neighbours are included. If bnd is zero, only the non-boundary neighbours are listed. The neighbours are listed in anticlockwise order starting with nb_id, if found.
\nInput:\u00a0\u00a0\u00a0 index\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Specifies the Elle node identifier of the triangulation point.
\nbnd\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 0, do not include flynn boundary nodes
\n1, include flynn boundary nodes
\nnb_id\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 neighbouring flynn boundary node
\nOutput:\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 nbnodes\u00a0\u00a0\u00a0 The list of nodes connected to the triangulation point with the Elle identifier, index.
\non_bnd\u00a0\u00a0\u00a0 corresponds to nbnodes, 0 for a unode, 1 for a boundary node<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201cdisplay.h\u201d
\nvoid EllePlotTriangles()
\nDescription:\u00a0\u00a0\u00a0 Plots triangulation data \u2013 currently used to plot the unode triangulation and by the diffusion example.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nvoid ElleSetSaveFileRoot(char *name)
\nDescription:\u00a0\u00a0\u00a0 Specifies the root of the filename for any files written.
\nInput:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 String to be used.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nvoid ElleSetSaveFrequency(int freq)
\nDescription:\u00a0\u00a0\u00a0 Specifies how often an Elle file should be saved eg if freq is n, a file will be saved after every nth stage. The filename will be a concatenation of the file root, the stage number and the \u201c.elle\u201d suffix.
\nInput:\u00a0\u00a0\u00a0 freq\u00a0\u00a0\u00a0 Specifies the interval for saving Elle files.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nvoid ElleSetVerbose(int state)
\nDescription:\u00a0\u00a0\u00a0 Sets a flag specifying whether the process should output information to the terminal during execution (Not properly implemented).
\nInput:\u00a0\u00a0\u00a0 0 or 1.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nvoid ElleSetDisplay(int state)
\nDescription:\u00a0\u00a0\u00a0 Sets a flag specifying whether the process should open an X window or run in batch mode. Display is usually set to 1 (for graphical display) while developing a process and set to 0 for background execution.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nvoid ElleSetStages(int state)
\nDescription:\u00a0\u00a0\u00a0 Sets the number of times to run through a loop in the process [20] . See the template files.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nvoid ElleSetInitFunction(ElleRunFunc myfunc)
\nDescription:\u00a0\u00a0\u00a0 Sets the function to be run when the process is initialised (on startup, when an Elle data file is opened or when the process is rerun.
\nInput:\u00a0\u00a0\u00a0 myfunc\u00a0\u00a0\u00a0 The name of the function of type ElleRunFunc.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nElleRunFunc ElleInitFunction()
\nDescription:\u00a0\u00a0\u00a0 Returns a pointer to\u00a0 the function set by ElleSetInitFunction.
\nReturns:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 The function of type ElleRunFunc. Returns 0 if ElleSetInitFunction has not been called.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nvoid ElleSetRunFunction(ElleRunFunc myfunc)
\nDescription:\u00a0\u00a0\u00a0 Sets the function to be run when the process is started or when the process is rerun.\u00a0 See the template files.
\nInput:\u00a0\u00a0\u00a0 myfunc\u00a0\u00a0\u00a0 The name of the function of type ElleRunFunc.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nElleRunFunc ElleRunFunction()
\nDescription:\u00a0\u00a0\u00a0 Returns a pointer to\u00a0 the function set by ElleSetRunFunction.
\nReturns:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 The function of type ElleRunFunc. Returns 0 if ElleSetRunFunction has not been called.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nvoid ElleSetExitFunction(ElleRunFunc myfunc)
\nDescription:\u00a0\u00a0\u00a0 Sets the function to be run when the process is terminated. See the template files.
\nInput:\u00a0\u00a0\u00a0 myfunc\u00a0\u00a0\u00a0 The name of the function of type ElleRunFunc.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nElleRunFunc ElleExitFunction()
\nDescription:\u00a0\u00a0\u00a0 Returns a pointer to\u00a0 the function set by ElleSetExitFunction.
\nReturns:\u00a0\u00a0\u00a0 The function of type ElleRunFunc. Returns 0 if ElleSetExitFunction has not been called.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nvoid ElleSetFile(char *filename)
\nDescription:\u00a0\u00a0\u00a0 Sets the Elle data file to be read when the process is started or when the process is rerun.
\nInput:\u00a0\u00a0\u00a0 filename\u00a0\u00a0\u00a0 The name of the Elle data file.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nchar *ElleFile()
\nDescription:\u00a0\u00a0\u00a0 Returns a pointer to the name of the Elle data file.\u00a0 This may be an empty string if a file has not been opened.
\nReturns:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 Pointer to the Elle data file name.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nvoid ElleSetSwitchdistance(double val)
\nDescription:\u00a0\u00a0\u00a0 Sets the minimum separation distance for triple nodes. The value is used in the topology check routines to control triple switching.\u00a0 This function sets the minimum separation for double nodes to val and the maximum separation for double nodes to val*2.2
\nInput:\u00a0\u00a0\u00a0 val\u00a0\u00a0\u00a0 The minimum separation distance for triple nodes.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\ndouble ElleSwitchdistance()
\nDescription:\u00a0\u00a0\u00a0 Returns the setting for the minimum separation distance for triple nodes [0.025]. The value is used in the topology check routines to control triple switching.
\nReturns:\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 The switch distance for triple nodes.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nvoid ElleSetSpeedup(double val)
\nDescription:\u00a0\u00a0\u00a0 Limits the distance a node may move in any one time step.
\nInput:\u00a0\u00a0\u00a0 val\u00a0\u00a0\u00a0 The speedup value.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\ndouble ElleSpeedup()
\nDescription:\u00a0\u00a0\u00a0 Returns the speedup value \u2013 a parameter which limits the distance a node may move in any one time step.
\nReturns:\u00a0\u00a0\u00a0 The speedup value.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\ndouble EllemaxNodeSep()
\nDescription:\u00a0\u00a0\u00a0 Returns the maximum separation distance for double nodes. Check routines may insert nodes if this distance is exceeded. This value is set when the switch distance is set.
\nReturns:\u00a0\u00a0\u00a0 The maximum node separation.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\ndouble ElleminNodeSep()
\nDescription:\u00a0\u00a0\u00a0 Returns the minimum separation distance for double nodes. Check routines may remove nodes if boundaries become shorter than the minimum. This value is set when the switch distance is set.
\nReturns:\u00a0\u00a0\u00a0 The minimum node separation.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nint ElleReadOptionData(FILE *fp,char *str)
\nDescription:\u00a0\u00a0\u00a0 Reads the data in the OPTIONS section of an Elle file.
\nInput:\u00a0\u00a0\u00a0 fp\u00a0\u00a0\u00a0 The pointer to the file stream opened for reading
\nstr\u00a0\u00a0\u00a0 A buffer into which lines from the file are read
\nReturns:\u00a0\u00a0\u00a0 0, if it reads the section successfully, else an error number<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nint ElleWriteOptionData(FILE *fp)
\nDescription:\u00a0\u00a0\u00a0 Writes the OPTIONS section of an Elle file.
\nInput:\u00a0\u00a0\u00a0 fp\u00a0\u00a0\u00a0 The pointer to the file stream opened for writing
\nReturns:\u00a0\u00a0\u00a0 0, if it writes the section successfully, else an error number<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nchar *ElleSaveFileRoot(void)
\nDescription:\u00a0\u00a0\u00a0 Returns a pointer to the string used as the root of the name for any files written
\nReturns:\u00a0\u00a0\u00a0 A char pointer.\u00a0 (This is the address of the field in the global structure)<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nint EllemaxStages(void)
\nDescription:\u00a0\u00a0\u00a0 This function returns the setting for stages. The default is 20 and it may be reset by calling the function ElleSetStages() or via the Set Options dialog box (Run menu)
\nReturns:\u00a0\u00a0\u00a0 an integer value<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nint ElleDisplay(void)
\nDescription:\u00a0\u00a0\u00a0 Returns the value of a flag specifying whether the process should open an X window or run in batch mode
\nReturns:\u00a0\u00a0\u00a0 0 or 1<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\ndouble ElleTemperature(void)
\nDescription:\u00a0\u00a0\u00a0 Returns the current temperature value
\nReturns:\u00a0\u00a0\u00a0 a double value<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\ndouble EllePressure(void)
\nDescription:\u00a0\u00a0\u00a0 Returns the current pressure value
\nReturns:\u00a0\u00a0\u00a0 a double value<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\ndouble ElleBoundaryWidth(void)
\nDescription:\u00a0\u00a0\u00a0 Returns the boundary width value (assumed to be in metres). Default is 1e-9m.
\nReturns:\u00a0\u00a0\u00a0 a double value<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\ndouble ElleUnitLength(void)
\nDescription:\u00a0\u00a0\u00a0 Returns the length of the unit cell (assumed to be in metres). Default is 1cm.
\nReturns:\u00a0\u00a0\u00a0 a double value<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nvoid ElleSetUnitLength(double val)
\nDescription:\u00a0\u00a0\u00a0 Sets the value used to scale the unit cell
\nInput:\u00a0\u00a0\u00a0 val\u00a0\u00a0\u00a0 The length value (assumed to be metres).<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nvoid ElleSetBoundaryWidth(double val)
\nDescription:\u00a0\u00a0\u00a0 Changes the boundary width value applied to all grain boundaries
\nInput:\u00a0\u00a0\u00a0 val\u00a0\u00a0\u00a0 The pressure value.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nvoid ElleSetPressure(double val)
\nDescription:\u00a0\u00a0\u00a0 Sets the current pressure value
\nInput:\u00a0\u00a0\u00a0 val\u00a0\u00a0\u00a0 The new value.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nvoid ElleSetTemperature(double val)
\nDescription:\u00a0\u00a0\u00a0 Sets the current temperature value
\nInput:\u00a0\u00a0\u00a0 val\u00a0\u00a0\u00a0 The new value.<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nint ElleSetCellBBox(Coords *baseleft, Coords *baseright,
\nCoords *topright, Coords *topleft)
\nDescription:\u00a0\u00a0\u00a0 Sets the bounding box for the unit cell.
\nReturns:\u00a0\u00a0\u00a0 0 if the values are set. Returns 1 if the coordinates of the corners do not seem topologically correct<\/p>\n
\nSynopsis:\u00a0\u00a0\u00a0 #include \u201crunopts.h\u201d
\nvoid ElleCellBBox(CellData *data)
\nDescription:\u00a0\u00a0\u00a0 Copies the bounding box structure to the input variable.
\nInput:\u00a0\u00a0\u00a0 The address of a variable of type CellData<\/p>\n