OpenCMISS::Zinc::Fieldsmoothing Class Reference

Parameters for smoothing a field. More...

#include <fieldsmoothing.hpp>

Public Types
enum	Algorithm { ALGORITHM_INVALID = CMZN_FIELDSMOOTHING_ALGORITHM_INVALID, ALGORITHM_AVERAGE_DELTA_DERIVATIVES_UNSCALED = CMZN_FIELDSMOOTHING_ALGORITHM_AVERAGE_DELTA_DERIVATIVES_UNSCALED }

Public Member Functions
	Fieldsmoothing (cmzn_fieldsmoothing_id in_fieldsmoothing_id)
	Fieldsmoothing (const Fieldsmoothing &fieldsmoothing)
Fieldsmoothing &	operator= (const Fieldsmoothing &fieldsmoothing)
bool	isValid () const
cmzn_fieldsmoothing_id	getId () const
int	setAlgorithm (Algorithm algorithm)
int	setTime (double time)

Protected Attributes
cmzn_fieldsmoothing_id	id

Detailed Description

Parameters for smoothing a field.

See also

Field::smooth

Specification of algorithm and parameters for smoothing a field.

Member Enumeration Documentation

enum OpenCMISS::Zinc::Fieldsmoothing::Algorithm

Algorithm for smoothing a field with derivative degrees of freedom.

Enumerator
ALGORITHM_INVALID	Invalid algorithm
ALGORITHM_AVERAGE_DELTA_DERIVATIVES_UNSCALED	Sets unit scale factors with first derivatives set to average of nodal value deltas along neighbouring lines. Default algorithm.

Member Function Documentation

cmzn_fieldsmoothing_id OpenCMISS::Zinc::Fieldsmoothing::getId ( ) const

inline

Return the C handle of the Fieldsmoothing object.

Returns

C handle of Fieldsmoothing if this objects is valid, 0 otherwise.

bool OpenCMISS::Zinc::Fieldsmoothing::isValid ( ) const

inline

Check if this is a valid Fieldsmoothing object.

Returns

Status True if object is valid, false otherwise.

int OpenCMISS::Zinc::Fieldsmoothing::setAlgorithm ( Algorithm  algorithm )

inline

Set the smoothing algorithm to be used for smoothing a field.

Parameters

algorithm	Region field module owning the fields to be smoothed.
algorithm	The smoothing algorithm to use.

Returns

Handle to new field smoothing, or NULL/invalid handle on failure.

int OpenCMISS::Zinc::Fieldsmoothing::setTime ( double  time )

inline

Sets the time at which to smooth the field, if time varying.

Parameters

time	The time value to be set.

Returns

Status OpenCMISS::Zinc::OK on success, any other value on failure.

---

The documentation for this class was generated from the following file:

• auto_comments_output/fieldsmoothing.hpp