standard_dof_tuple_index.cc

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

// Definitions for standard_dof_tuple_index facet of namespace sheaf.


#include "SheafSystem/standard_dof_tuple_index.h"

#include "SheafSystem/assert_contract.h"
#include "SheafSystem/std_string.h"

using namespace std;

namespace
{
const int STANDARD_DOF_TUPLE_INDEX_CT =
  sheaf::STANDARD_DOF_TUPLE_INDEX_END - sheaf::STANDARD_DOF_TUPLE_INDEX_BEGIN;
}

sheaf::standard_dof_tuple_index&
sheaf::
operator++(standard_dof_tuple_index& x)
{
  return x =
           (x == STANDARD_DOF_TUPLE_INDEX_END) ?
           STANDARD_DOF_TUPLE_INDEX_BEGIN :
           standard_dof_tuple_index(x+1);
};

const std::string&
sheaf::
standard_dof_tuple_index_to_name(standard_dof_tuple_index xpt)
{
  // Preconditions:

  // Body:

  static const string names[STANDARD_DOF_TUPLE_INDEX_CT+1] =
    {
      "EMPTY_DOF_TUPLE_INDEX",
      "NOT_A_STANDARD_DOF_TUPLE_INDEX"
    };

  const string* lresult_ptr = &names[STANDARD_DOF_TUPLE_INDEX_CT];

  pod_index_type lpt = xpt;
  if(is_standard_dof_tuple_index(lpt))
  {
    lresult_ptr = &names[lpt - STANDARD_DOF_TUPLE_INDEX_BEGIN];
  }

  const string& result = *lresult_ptr;

  // Postconditions:

  ensure(!result.empty());

  // Exit:

  return result;
}

sheaf::standard_dof_tuple_index
sheaf::
standard_dof_tuple_index_from_name(const std::string& xname)
{
  standard_dof_tuple_index result = NOT_A_STANDARD_DOF_TUPLE_INDEX;
  for(standard_dof_tuple_index i=STANDARD_DOF_TUPLE_INDEX_BEGIN;
      i< STANDARD_DOF_TUPLE_INDEX_END;
      ++i)
  {
    if(standard_dof_tuple_index_to_name(i) == xname)
    {
      result = i;
      break;
    }
  }

  return result;
}

sheaf::standard_dof_tuple_index
sheaf::
standard_dof_tuple_index_from_index(pod_index_type xindex)
{
  // Preconditions:

  // Body:

  static const standard_dof_tuple_index prims[STANDARD_DOF_TUPLE_INDEX_CT+1] =
    {
      EMPTY_DOF_TUPLE_INDEX,
      NOT_A_STANDARD_DOF_TUPLE_INDEX
    };

  standard_dof_tuple_index result = prims[STANDARD_DOF_TUPLE_INDEX_CT];
  if(is_standard_dof_tuple_index(xindex))
  {
    result = prims[xindex];
  }

  // Postconditions:

  // Exit:

  return result;
}

bool
sheaf::
is_standard_dof_tuple_index(pod_index_type xindex)
{
  bool result;

  // Preconditions:

  // Body:

  result =
    (STANDARD_DOF_TUPLE_INDEX_BEGIN <= xindex) && (xindex < STANDARD_DOF_TUPLE_INDEX_END);

  // Postconditions:

  // Exit

  return result;
}