section_eval_iterator.h

//
// Copyright (c) 2014 Limit Point Systems, Inc. 
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

// Interface for class section_eval_iterator

#ifndef SECTION_EVAL_ITERATOR_H
#define SECTION_EVAL_ITERATOR_H

#ifndef SHEAF_DLL_SPEC_H
#include "SheafSystem/sheaf_dll_spec.h"
#endif

#ifndef EVAL_ITERATOR_H
#include "SheafSystem/eval_iterator.h"
#endif

#ifndef POSET_DOF_ITERATOR_H
#include "SheafSystem/poset_dof_iterator.h"
#endif

#ifndef SEC_VD_H
#include "SheafSystem/sec_vd.h" // just to get typedefs
#endif

namespace sheaf
{
template <typename T>
class block;
}

namespace fiber_bundle
{

using namespace sheaf;


class section_evaluator;
class section_space_schema_member;

class SHEAF_DLL_SPEC section_eval_iterator : public any
{

public:

  // CANONICAL MEMBERS

  section_eval_iterator(const section_space_schema_member& xanchor);

  virtual section_eval_iterator&
  operator=(const section_eval_iterator& xother);

  section_eval_iterator(const section_eval_iterator& xother);

  section_eval_iterator();

  virtual ~section_eval_iterator();

  virtual bool is_ancestor_of(const any* xother) const;

  virtual section_eval_iterator* clone() const;

  bool invariant() const;

  // ITERATOR FACET

  bool is_initialized() const;

  // Anchor is not virtual; descendant redefinitions
  // with covariant signature hide this version.

  section_space_schema_member& anchor();

  const section_space_schema_member& anchor() const;

  virtual bool anchor_is_ancestor_of(const section_space_schema_member& xmbr) const;

  virtual void reset(bool xreset_markers = RESET);

  virtual void reset(pod_index_type xhub_id, bool xreset_markers = RESET);

  void reset(const scoped_index& xid, bool xreset_markers = RESET);

  virtual void reset(const section_space_schema_member& xanchor);

  virtual void reset_components();

  virtual int ct(bool xreset = false);

  virtual bool has_visited(pod_index_type xhub_id) const;

  bool has_visited(const scoped_index& xid) const;

  virtual bool has_visited(const section_space_schema_member& xmbr) const;

  virtual void put_has_visited(pod_index_type xhub_id, bool xvalue);

  void put_has_visited(const scoped_index& xid, bool xvalue);

  // SECTION_EVAL_ITERATOR FACET

  const scoped_index& evaluator_id() const;

  section_evaluator& evaluator();

  const section_evaluator& evaluator() const;

  bool evaluators_done() const;

  virtual void next_evaluator();

  bool components_done() const;
  
  virtual void next_component();

  block<scoped_index>& discretization_members();

  const block<scoped_index>& discretization_members() const;

  const scoped_index& fiber_id() const;
  
  void gather_dofs(const sec_vd& xsec, block<sec_vd::dof_type>& xdofs);

  void scatter_dofs(sec_vd& xsec, const block<sec_vd::dof_type>& xdofs, size_type xindex);


protected:

  void reset_anchor(const section_space_schema_member& xanchor);

  section_space_schema_member* _anchor;

  postorder_iterator _fiber_schema_itr;

  eval_iterator _evaluation_itr;

  //   ///
  //   ///
  //   scoped_index _fiber_id;
};

} // namespace fiber_bundle

#endif // ifndef SECTION_EVAL_ITERATOR_H