PK_FACE_check_pair

PK_ERROR_code_t                PK_FACE_check_pair
(
--- received arguments ---
PK_FACE_t                      face_1,       --- face to be checked
PK_FACE_t                      face_2,       --- face to be checked
const PK_FACE_check_pair_o_t  *options,      --- options structure

--- returned arguments ---
int                     *const n_faults,     --- number of faults
PK_check_fault_t       **const faults        --- faults
)


This function checks the given pair of faces.


Specific Errors:
    PK_ERROR_check_error        a fault has been found when max_faults = 0
                                (MILD)
    PK_ERROR_check_failure      checker failure (MILD)
    PK_ERROR_bad_option_data    max_faults < 0 (MILD)
    PK_ERROR_not_in_same_body   faces are not both from the same body (MILD)



This function performs a series of checks on a pair of faces,
and returns information about the faults found, if any.


option structure
------ ---------
The option structure allows the caller to control which checks are performed;
if no options are supplied, all checks appropriate to the face pair will be
made.

The option structure allows the following to be set:

    'max_faults'
        maximum number of faults to be returned and whether to force checking
        to raise a PK error instead of returning check faults.


The check fault associated with this check is as follows

'state'                        |'entity_1'|'entity_2'|     'position'
-------------------------------------------------------------------------------
PK_FACE_state_bad_face_face_c  |   face   |   face   | point in region of
                               |          |          |    inconsistency
                               |          |          |

Faults are returned in an array of PK_check_fault_t structures.
If there are no faults found, then 'n_faults' is returned as zero.

If there is more than one fault then the function does not
guarantee to return all the faults.

For more details on fault types and how they may arise, see the chapter on
'Checking' in the Functional Description.