Contribution Class Reference

Represents the node that the particle contributes. More...

#include <Contribution.h>

Collaboration diagram for Contribution:

Public Member Functions
	Contribution ()
	Default constructor.
virtual	~Contribution ()
	Default destructor.
int	getNodeId () const
	Return the node identification.
double	getWeight () const
	Return the weight value.
const Vector3d &	getGradients () const
	Return the gradients values.
void	setNodeId (int nodal_id)
	Configure node identification.
void	setWeight (double nodal_weight)
	Configure weight.
void	setGradients (const Vector3d &nodal_gradients)
	Configure gradients.

Private Attributes
int	nodeId
	identification of node \( I \)
double	weight
	weight value of a node at a particle position \( N_I(x_p) \)
Vector3d	gradient
	gradient value of a node at a particle position \( N_{I,j}(x_p) = dN/dx_{I}(x_p), dN/dy_{I}(x_p), dN/dz_{I}(x_p) \).

Detailed Description

Represents the node that the particle contributes.

During the interpolation process values stored in to the particles are calculated in mesh nodes using interpolation functions \( N_I(x_p) \) and its gradients \( N_{I,j}(x_p) \). Each of these functions are defined at the node \( I \) and evaluated at particle position \( x_p \).

This class store the nodal id \( I \) and the values of \( N_I(x_p) \) and \( N_{I,j}(x_p) \).

Constructor & Destructor Documentation

Contribution()

Contribution::Contribution ( )

inline

Default constructor.

~Contribution()

Contribution::~Contribution ( )

inlinevirtual

Default destructor.

Member Function Documentation

getGradients()

const Vector3d & Contribution::getGradients ( ) const

inline

Return the gradients values.

Returns

Nodal gradients. Nodal gradients in each direction evaluated at the particle position

getNodeId()

int Contribution::getNodeId ( ) const

inline

Return the node identification.

Returns

Node identification

getWeight()

double Contribution::getWeight ( ) const

inline

Return the weight value.

Returns

Nodal weight. Value of the nodal weight evaluated at the particle position

setGradients()

void Contribution::setGradients ( const Vector3d & nodal_gradients )

inline

Configure gradients.

Parameters

[in]

nodal_gradients

Nodal gradients in each direction evaluated at the particle position

setNodeId()

void Contribution::setNodeId ( int nodal_id )

inline

Configure node identification.

Parameters

[in]

nodal_id

Node identification

setWeight()

void Contribution::setWeight ( double nodal_weight )

inline

Configure weight.

Parameters

[in]

nodal_weight

Value of the nodal weight evaluated at the particle position

Member Data Documentation

gradient

Vector3d Contribution::gradient

private

gradient value of a node at a particle position \( N_{I,j}(x_p) = dN/dx_{I}(x_p), dN/dy_{I}(x_p), dN/dz_{I}(x_p) \).

nodeId

int Contribution::nodeId

private

identification of node \( I \)

weight

double Contribution::weight

private

weight value of a node at a particle position \( N_I(x_p) \)

---

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

• Contribution.h