b2api
B2000++ API Reference Manual, VERSION 4.6
 
Loading...
Searching...
No Matches
b2000::GradientContainer Class Referenceabstract

#include "b2solution.H"

Inheritance diagram for b2000::GradientContainer:
Collaboration diagram for b2000::GradientContainer:

Classes

struct  FieldDescription
 
struct  InternalElementPosition
 

Public Member Functions

virtual bool set_current_element (const Element &e)=0
 
virtual void set_current_position (const InternalElementPosition &pos, const double volume=0)=0
 
virtual void set_current_volume (const double volume)=0
 
virtual void set_field_value (const FieldDescription &descr, const int *value)
 
virtual void set_field_value (const FieldDescription &descr, const double *value)
 
virtual void set_field_value (const FieldDescription &descr, const b2000::csda< double > *value)
 
virtual void set_field_value (const FieldDescription &descr, const std::complex< double > *value)
 
virtual void set_failure_index (const double failure_index)
 
virtual bool compute_field_value (const std::string &name) const
 
- Public Member Functions inherited from b2000::Object
virtual const std::string & get_object_name () const
 
virtual ~Object ()
 

Additional Inherited Members

- Static Public Attributes inherited from b2000::Object
static ObjectType type
 

Detailed Description

Abstract base class to hold all gradient data corresponding to a single solution of a complete FE model. The data items are distinguished by their kind (see FieldDescription), by the Element to which they belong, and by the element-internal position (see InternalElementPosition).

Member Function Documentation

◆ compute_field_value()

virtual bool b2000::GradientContainer::compute_field_value ( const std::string &  name) const
inlinevirtual

Returns true if gradient data has been inserted. This function must be overridden in derived classes.

◆ set_current_element()

virtual bool b2000::GradientContainer::set_current_element ( const Element e)
pure virtual

Tells the GradientContainer object what is the current Finite Element. This function is called by the Solver instance.

◆ set_current_position()

virtual void b2000::GradientContainer::set_current_position ( const InternalElementPosition pos,
const double  volume = 0 
)
pure virtual

Tells the GradientContainer object what is the current position inside the current Finite Element. This function is called by the Element instances.

◆ set_current_volume()

virtual void b2000::GradientContainer::set_current_volume ( const double  volume)
pure virtual

Tells the GradientContainer object what is the current volume inside the current Finite Element. This function must by called by the property object when the volume is not known by the element itself. This could be possible with some implementation of structure element.

◆ set_failure_index()

virtual void b2000::GradientContainer::set_failure_index ( const double  failure_index)
inlinevirtual

Set the value for the failure index at the current position.

◆ set_field_value() [1/4]

virtual void b2000::GradientContainer::set_field_value ( const FieldDescription descr,
const b2000::csda< double > *  value 
)
inlinevirtual

Inserts an array of csda floating-point values at the current position.

Parameters
descrDescribes the kind of data.
valueA pointer to the array containing the data to store. The length of the array must be equal to descr.nb_comp.

◆ set_field_value() [2/4]

virtual void b2000::GradientContainer::set_field_value ( const FieldDescription descr,
const double *  value 
)
inlinevirtual

Inserts an array of real floating-point values at the current position.

Parameters
descrDescribes the kind of data.
valueA pointer to the array containing the data to store. The length of the array must be equal to descr.nb_comp.

◆ set_field_value() [3/4]

virtual void b2000::GradientContainer::set_field_value ( const FieldDescription descr,
const int *  value 
)
inlinevirtual

Inserts an array of integer values at the current position.

Parameters
descrDescribes the kind of data.
valueA pointer to the integer array containing the data to store. The length of the array must be equal to descr.nb_comp.

◆ set_field_value() [4/4]

virtual void b2000::GradientContainer::set_field_value ( const FieldDescription descr,
const std::complex< double > *  value 
)
inlinevirtual

Inserts an array of complex floating-point values at the current position.

Parameters
descrDescribes the kind of data.
valueA pointer to the array containing the data to store. The length of the array must be equal to descr.nb_comp.

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