stk::mesh::FieldRelation Struct Reference

A defined entity-relationship between a field of a pointer type and the field that it should point to. More...

#include <FieldRelation.hpp>

List of all members.

Public Attributes
FieldBase *	m_root
	relation domain part
FieldBase *	m_target
	relation range part
relation_stencil_ptr	m_function
	relation stencil

---

Detailed Description

A defined entity-relationship between a field of a pointer type and the field that it should point to.

An internal class that should never need to be directly used within application code.

Let

• rel be the relation from entity e1 to entity e2

If

• field m_root has a pointer scalar type 'T *' AND
• field m_target has a scalar type 'T' AND
• field_data( *m_root , e1 ) exists AND
• field_data( *m_target , e2 ) exists AND
• relation rel is in the domain of relation stencil m_function

then

    index = (*m_function)( e1.entity_rank() ,
                           e2.entity_rank() ,
                           rel.identifier() ,
                           rel.kind() );

    field_data(*m_root,e1)[index] == field_data(*m_target,e2)
  

Definition at line 50 of file FieldRelation.hpp.

---

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

• FieldRelation.hpp