displacement_control_element.h

Go to the documentation of this file.

// LIC// ====================================================================
// LIC// This file forms part of oomph-lib, the object-oriented,
// LIC// multi-physics finite-element library, available
// LIC// at http://www.oomph-lib.org.
// LIC//
// LIC// Copyright (C) 2006-2022 Matthias Heil and Andrew Hazel
// LIC//
// LIC// This library is free software; you can redistribute it and/or
// LIC// modify it under the terms of the GNU Lesser General Public
// LIC// License as published by the Free Software Foundation; either
// LIC// version 2.1 of the License, or (at your option) any later version.
// LIC//
// LIC// This library is distributed in the hope that it will be useful,
// LIC// but WITHOUT ANY WARRANTY; without even the implied warranty of
// LIC// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// LIC// Lesser General Public License for more details.
// LIC//
// LIC// You should have received a copy of the GNU Lesser General Public
// LIC// License along with this library; if not, write to the Free Software
// LIC// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// LIC// 02110-1301  USA.
// LIC//
// LIC// The authors may be contacted at oomph-lib@maths.man.ac.uk.
// LIC//
// LIC//====================================================================
// Header file for classes that define element objects
 
// Include guard to prevent multiple inclusions of the header
#ifndef OOMPH_DISPLACEMENT_CONTROL_ELEMENT_HEADER
#define OOMPH_DISPLACEMENT_CONTROL_ELEMENT_HEADER
 
 
// Config header generated by autoconfig
#ifdef HAVE_CONFIG_H
#include <oomph-lib-config.h>
#endif
 
#include <deque>
 
// oomph-lib includes
#include "elements.h"
 
namespace oomph
{
  //======================================================================
  //======================================================================
  class DisplacementControlElement : public virtual GeneralisedElement
  {
  public:
    DisplacementControlElement(SolidFiniteElement* controlled_element_pt,
                               const Vector<double>& controlled_point,
                               const unsigned& controlled_direction,
                               double* control_position_value_pt,
                               Data* displacement_control_load_pt)
      : Displacement_control_load_pt(displacement_control_load_pt),
        Control_position_value_pt(control_position_value_pt),
        Controlled_direction(controlled_direction),
        Controlled_element_pt(controlled_element_pt),
        Controlled_point(controlled_point)
    {
#ifdef PARANOID
      if (displacement_control_load_pt->nvalue() != 1)
      {
        throw OomphLibError(
          "Displacement control data must only contain a single value!\n",
          OOMPH_CURRENT_FUNCTION,
          OOMPH_EXCEPTION_LOCATION);
      }
#endif
 
      // The displacement control load is external Data for this element;
      // add it to the container and and store its index in that container.
      Load_data_index = add_external_data(Displacement_control_load_pt);
 
      // Store flag
      Load_data_created_internally = false;
 
      // The positional degrees of freedom of all the nodes in the
      // controlled SolidFiniteElement are external Data
      // for this element
      unsigned nnode = Controlled_element_pt->nnode();
      for (unsigned j = 0; j < nnode; j++)
      {
        add_external_data(
          static_cast<SolidNode*>(Controlled_element_pt->node_pt(j))
            ->variable_position_pt());
      }
    }
 
    DisplacementControlElement(SolidFiniteElement* controlled_element_pt,
                               const Vector<double>& controlled_point,
                               const unsigned& controlled_direction,
                               double* control_position_value_pt)
      : Control_position_value_pt(control_position_value_pt),
        Controlled_direction(controlled_direction),
        Controlled_element_pt(controlled_element_pt),
        Controlled_point(controlled_point)
    {
      // Create displacement control load internally (below, we'll store it
      // in the element's internal data so it'll be killed automatically --
      // no need for a destructor)
      Displacement_control_load_pt = new Data(1);
 
      // The displacement control load is internal Data for this element
      Load_data_index = add_internal_data(Displacement_control_load_pt);
 
      // Store flag
      Load_data_created_internally = true;
 
      // The positional degrees of freedom of all the nodes in the
      // controlled SolidFiniteElement are external Data
      // for this element
      unsigned nnode = Controlled_element_pt->nnode();
      for (unsigned j = 0; j < nnode; j++)
      {
        add_external_data(
          static_cast<SolidNode*>(Controlled_element_pt->node_pt(j))
            ->variable_position_pt());
      }
    }
 
    DisplacementControlElement(const DisplacementControlElement&) = delete;
 
 
    void operator=(const DisplacementControlElement&) = delete;
 
 
    Data* displacement_control_load_pt() const
    {
      return Displacement_control_load_pt;
    }
 
 
    void assign_additional_local_eqn_numbers()
    {
      if (Load_data_created_internally)
      {
        // Local equation number is the local equation number of the
        // one and only (i.e. the zero-th value stored in the
        // load data (which is stored in the internal data)
        Displ_ctrl_local_eqn = internal_local_eqn(Load_data_index, 0);
      }
      else
      {
        // Local equation number is the local equation number of the
        // one and only (i.e. the zero-th value stored in the
        // load data (which is stored in the external data)
        Displ_ctrl_local_eqn = external_local_eqn(Load_data_index, 0);
      }
    }
 
 
    void fill_in_contribution_to_residuals(Vector<double>& residuals)
    {
      if (Displ_ctrl_local_eqn >= 0)
      {
        residuals[Displ_ctrl_local_eqn] =
          Controlled_element_pt->interpolated_x(Controlled_point,
                                                Controlled_direction) -
          *Control_position_value_pt;
      }
    }
 
    unsigned ndof_types() const
    {
      return 1;
    }
 
    void get_dof_numbers_for_unknowns(
      std::list<std::pair<unsigned long, unsigned>>& dof_lookup_list) const
    {
      if (Load_data_created_internally)
      {
        // temporary pair (used to store dof lookup prior to being
        // added to list)
        std::pair<unsigned long, unsigned> dof_lookup;
 
        // determine local eqn number for displacement control eqn
        int local_eqn_number = Displ_ctrl_local_eqn;
 
        // Is it a dof or is it pinned?
        if (local_eqn_number >= 0)
        {
          // store dof lookup in temporary pair: First entry in pair
          // is global equation number; second entry is dof type
          dof_lookup.first = this->eqn_number(local_eqn_number);
          dof_lookup.second = 0;
 
          // Add to list
          dof_lookup_list.push_front(dof_lookup);
        }
      }
    }
 
  protected:
    Data* Displacement_control_load_pt;
 
    double* Control_position_value_pt;
 
    unsigned Controlled_direction;
 
    SolidFiniteElement* Controlled_element_pt;
 
    Vector<double> Controlled_point;
 
    bool Load_data_created_internally;
 
    unsigned Load_data_index;
 
    int Displ_ctrl_local_eqn;
  };
 
} // namespace oomph
 
#endif