field_refiner_family.h

Go to the documentation of this file.

//
// 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.
//


#ifndef FIELD_REFINER_FAMILY_H
#define FIELD_REFINER_FAMILY_H

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

#ifndef ANY_H
#include "SheafSystem/any.h"
#endif

#ifndef BLOCK_H
#include "SheafSystem/block.h"
#endif

#ifndef STD_STRING_H
#include "SheafSystem/std_string.h"
#endif

namespace sheaf
{
template <class T>
class factory;
class index_space_handle;
class namespace_poset;
}

namespace fiber_bundle
{
class base_space_poset;
}

namespace fields
{

using namespace sheaf;
using namespace fiber_bundle;

class field_refinement_policy;
class local_field_refiner;
class field_refiner_family_factory;


class SHEAF_DLL_SPEC field_refiner_family : public any
{

  // ===========================================================
  // ===========================================================

public:

  static field_refiner_family* new_family(const std::string& xname);

  field_refiner_family(const field_refiner_family& xother);

  virtual ~field_refiner_family();

  virtual const std::string& class_name() const = 0;

  local_field_refiner* member(pod_index_type xtype_id) const;

  size_type size() const;

  field_refinement_policy& policy() const;

  static factory<field_refiner_family>& family_factory();

  virtual void initialize(const base_space_poset& xbase_space,
                          const field_refinement_policy& xpolicy) = 0;

  bool is_initialized() const;

protected:

  field_refiner_family();

  block<local_field_refiner*> _members;

  field_refinement_policy* _policy;

  index_space_handle* _cell_type_id_space;

  bool _is_initialized;



  // ===========================================================
  // ===========================================================

public:

  virtual field_refiner_family* clone() const;

  virtual bool invariant() const;

  virtual bool is_ancestor_of(const any* xother) const;


};

// ===========================================================
// NON-MEMBER FUNCTIONS
// ===========================================================
 
} // namespace fields

#endif // ifndef FIELD_REFINER_FAMILY_H