|
OpenCMISS-Zinc C++ API Documentation
|
A field returning the gradient of a source field with respect to a given coordinate field. More...
#include <fieldderivatives.hpp>
Friends | |
| FieldGradient | Fieldmodule::createFieldGradient (const Field &sourceField, const Field &coordinateField) |
Additional Inherited Members | |
 Public Types inherited from OpenCMISS::Zinc::Field | |
| enum | ChangeFlag { CHANGE_FLAG_NONE = CMZN_FIELD_CHANGE_FLAG_NONE, CHANGE_FLAG_ADD = CMZN_FIELD_CHANGE_FLAG_ADD, CHANGE_FLAG_REMOVE = CMZN_FIELD_CHANGE_FLAG_REMOVE, CHANGE_FLAG_IDENTIFIER = CMZN_FIELD_CHANGE_FLAG_IDENTIFIER, CHANGE_FLAG_DEFINITION = CMZN_FIELD_CHANGE_FLAG_DEFINITION, CHANGE_FLAG_FULL_RESULT = CMZN_FIELD_CHANGE_FLAG_FULL_RESULT, CHANGE_FLAG_PARTIAL_RESULT = CMZN_FIELD_CHANGE_FLAG_PARTIAL_RESULT, CHANGE_FLAG_RESULT = CMZN_FIELD_CHANGE_FLAG_RESULT, CHANGE_FLAG_FINAL = CMZN_FIELD_CHANGE_FLAG_FINAL } |
| enum | CoordinateSystemType { COORDINATE_SYSTEM_TYPE_INVALID = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_INVALID, COORDINATE_SYSTEM_TYPE_RECTANGULAR_CARTESIAN = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_RECTANGULAR_CARTESIAN, COORDINATE_SYSTEM_TYPE_CYLINDRICAL_POLAR = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_CYLINDRICAL_POLAR, COORDINATE_SYSTEM_TYPE_SPHERICAL_POLAR = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_SPHERICAL_POLAR, COORDINATE_SYSTEM_TYPE_PROLATE_SPHEROIDAL = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_PROLATE_SPHEROIDAL, COORDINATE_SYSTEM_TYPE_OBLATE_SPHEROIDAL = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_OBLATE_SPHEROIDAL, COORDINATE_SYSTEM_TYPE_FIBRE = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_FIBRE } |
| enum | DomainType { DOMAIN_TYPE_INVALID = CMZN_FIELD_DOMAIN_TYPE_INVALID, DOMAIN_TYPE_POINT = CMZN_FIELD_DOMAIN_TYPE_POINT, DOMAIN_TYPE_NODES = CMZN_FIELD_DOMAIN_TYPE_NODES, DOMAIN_TYPE_DATAPOINTS = CMZN_FIELD_DOMAIN_TYPE_DATAPOINTS, DOMAIN_TYPE_MESH1D = CMZN_FIELD_DOMAIN_TYPE_MESH1D, DOMAIN_TYPE_MESH2D = CMZN_FIELD_DOMAIN_TYPE_MESH2D, DOMAIN_TYPE_MESH3D = CMZN_FIELD_DOMAIN_TYPE_MESH3D, DOMAIN_TYPE_MESH_HIGHEST_DIMENSION = CMZN_FIELD_DOMAIN_TYPE_MESH_HIGHEST_DIMENSION } |
| enum | ValueType { VALUE_TYPE_INVALID = CMZN_FIELD_VALUE_TYPE_INVALID, VALUE_TYPE_REAL = CMZN_FIELD_VALUE_TYPE_REAL, VALUE_TYPE_STRING = CMZN_FIELD_VALUE_TYPE_STRING, VALUE_TYPE_MESH_LOCATION = CMZN_FIELD_VALUE_TYPE_MESH_LOCATION } |
| typedef int | ChangeFlags |
| typedef int | DomainTypes |
| Public Member Functions inherited from OpenCMISS::Zinc::Field | |
| Field (cmzn_field_id field_id) | |
| Field (const Field &field) | |
| Field & | operator= (const Field &field) |
| bool | isValid () const |
| cmzn_field_id | getId () const |
| Fieldassignment | createFieldassignment (const Field &sourceField) |
| bool | isManaged () |
| int | setManaged (bool value) |
| char * | getComponentName (int componentNumber) |
| int | setComponentName (int componentNumber, const char *name) |
| double | getCoordinateSystemFocus () |
| int | setCoordinateSystemFocus (double focus) |
| CoordinateSystemType | getCoordinateSystemType () |
| int | setCoordinateSystemType (CoordinateSystemType coordinateSystemType) |
| int | getNumberOfComponents () |
| char * | getName () |
| int | setName (const char *name) |
| int | getNumberOfSourceFields () |
| Field | getSourceField (int index) |
| bool | isTypeCoordinate () |
| int | setTypeCoordinate (bool value) |
| ValueType | getValueType () |
| Fieldmodule | getFieldmodule () const |
| int | assignMeshLocation (const Fieldcache &cache, const Element &element, int coordinatesCount, const double *coordinatesIn) |
| int | assignReal (const Fieldcache &cache, int valuesCount, const double *valuesIn) |
| int | assignString (const Fieldcache &cache, const char *stringValue) |
| Element | evaluateMeshLocation (const Fieldcache &cache, int coordinatesCount, double *coordinatesOut) |
| int | evaluateReal (const Fieldcache &cache, int valuesCount, double *valuesOut) |
| char * | evaluateString (const Fieldcache &cache) |
| int | evaluateDerivative (const Differentialoperator&differentialOperator, const Fieldcache &cache, int valuesCount, double *valuesOut) |
| bool | isDefinedAtLocation (const Fieldcache &cache) |
| int | smooth (const Fieldsmoothing &fieldsmoothing) |
| FieldComponent | castComponent () |
| FieldEdgeDiscontinuity | castEdgeDiscontinuity () |
| FieldEigenvalues | castEigenvalues () |
| FieldElementGroup | castElementGroup () |
| FieldFindMeshLocation | castFindMeshLocation () |
| FieldFiniteElement | castFiniteElement () |
| FieldGroup | castGroup () |
| FieldImage | castImage () |
| FieldImagefilterBinaryThreshold | castImagefilterBinaryThreshold () |
| FieldImagefilterDiscreteGaussian | castImagefilterDiscreteGaussian () |
| FieldImagefilterHistogram | castImagefilterHistogram () |
| FieldImagefilterThreshold | castImagefilterThreshold () |
| FieldMeshIntegral | castMeshIntegral () |
| FieldNodeGroup | castNodeGroup () |
| FieldStoredMeshLocation | castStoredMeshLocation () |
| FieldStoredString | castStoredString () |
| Protected Attributes inherited from OpenCMISS::Zinc::Field | |
| cmzn_field_id | id |
A field returning the gradient of a source field with respect to a given coordinate field.
A field returning the gradient of a source field with respect to a given coordinate field. Calculation will only succeed in any element with xi-dimension equal to the number of components in the <coordinate_field>. Sets the number of components in return field to the product of the number of components in the <source_field> and <coordinate_field>. Note the <source_field> does not have to be a scalar. If it has more than 1 component, all the derivatives of its first component w.r.t. the components of <coordinate_field> will be returned first, followed by the second component, etc. Hence, this function can return the standard gradient of a scalar source_field, and the deformation gradient if a deformed coordinate field is passed as the source_field. The gradient can also be calculated at nodes, albeit approximately using a finite difference approach by perturbing the coordinate field.
1.8.11
