Diffpack Documentation

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Search

FieldSelector Class Reference

view a general scalar field in terms of a component in a vector field. More...

#include <FieldSelector.h>

Inheritance diagram for FieldSelector::

Public Methods
	FieldSelector (Fields &v, int comp=1, const char *name=NULL)
	~FieldSelector ()
virtual bool	ok () const
virtual Grid*	getGridBase ()
virtual NUMT	valuePt (const Ptv(real) &x, real t=DUMMY)
virtual NUMT	valueFEM (const FiniteElement &fe, real t=DUMMY)
virtual NUMT	valueNode (int node, real t=DUMMY) const
virtual Ptv(NUMT)	derivativePt (const Ptv(real) &x, real t=DUMMY)
virtual void	derivativeFEM (Ptv(NUMT) &d, const FiniteElement &fe, real t=DUMMY)
virtual void	derivativeNode (Ptv(NUMT) &d, int node, real t=DUMMY)
Protected Attributes
int	i_comp
Handle(Fields)	fields

Detailed Description

view a general scalar field in terms of a component in a vector field.

NAME: FieldSelector - view a general scalar field in terms of a component in a vector field

DESCRIPTION:

This class implements a general scalar field in terms of a specified component vector of a given vector field. The vector field may be of arbitrary type. The class may be used to access a given component of a vector field which is not represented as a vector of scalar fields (as is the case for FieldsFE).

Constructor & Destructor Documentation

FieldSelector::FieldSelector ( Fields & v,

int comp = 1,

const char * name = NULL )

The constructor takes an optional field name as arguments. An alternative constructor takes a Fields object, the component number and and optional field name as arguments. If no component is given, 1 is assumed. If no field name is given, the name of the given vector field is used.

FieldSelector::~FieldSelector ( ) [inline]

Member Function Documentation

void FieldSelector::derivativeFEM ( Ptv(NUMT) & d,

const FiniteElement & fe,

real t = DUMMY ) [virtual]

Reimplemented from Field.

void FieldSelector::derivativeNode ( Ptv(NUMT) & d,

int node,

real t = DUMMY ) [virtual]

Reimplemented from Field.

Ptv(NUMT) FieldSelector::derivativePt ( const Ptv(real) & x,

real t = DUMMY ) [virtual]

evaluates the derivative of the field at a point in space and time.
Reimplemented from Field.

Grid * FieldSelector::getGridBase ( ) [virtual]

returns a Grid base class pointer of the field component
Reimplemented from Field.

bool FieldSelector::ok ( ) const [virtual]

checks that the scalar field is okay
Reimplemented from Field.

NUMT FieldSelector::valueFEM ( const FiniteElement & fe,

real t = DUMMY ) [virtual]

evaluates the field at a point in space and time, but the argument is a "FiniteElement" object which means that the evaluation process in a finite element context will be very efficient (since "FiniteElement" knows the element number and the local coordinates of the spatial point). The function is virtual and offers a unified interface to the evaluation of all types of fields in a finite element based simulator.
Reimplemented from Field.

NUMT FieldSelector::valueNode ( int node,

real t = DUMMY ) const [virtual]

evaluates the field at a nodal point in space and time.
Reimplemented from Field.

NUMT FieldSelector::valuePt ( const Ptv(real) & x,

real t = DUMMY ) [virtual]

evaluates the field at a point in space and time. The time argument can be omitted, the default value is then "DUMMY". Generally, we suggest to use "DUMMY" to check if fields are stationary.
Reimplemented from Field.

Member Data Documentation

Handle(Fields) FieldSelector::fields [protected]

int FieldSelector::i_comp [protected]

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

FieldSelector.h