1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/* *****************************************************************
    MESQUITE -- The Mesh Quality Improvement Toolkit

    Copyright 2004 Sandia Corporation and Argonne National
    Laboratory.  Under the terms of Contract DE-AC04-94AL85000
    with Sandia Corporation, the U.S. Government retains certain
    rights in this software.

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    (lgpl.txt) along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    [email protected], [email protected], [email protected],
    [email protected], [email protected], [email protected]

  ***************************************************************** */
// -*- Mode : c++; tab-width: 3; c-tab-always-indent: t; indent-tabs-mode: nil; c-basic-offset: 3
// -*-

/*! \file InstructionQueue.hpp

Header file for the MBMesquite::InstructionQueue class

  \author Thomas Leurent
  \date   2002-05-01
 */

#ifndef MSQ_INSTRUCTION_QUEUE_HPP
#define MSQ_INSTRUCTION_QUEUE_HPP

#include "Mesquite.hpp"
#include "IQInterface.hpp"

#include <list>

namespace MBMesquite
{

class MsqError;
class QualityImprover;
class QualityAssessor;
class Mesh;
class ParallelMesh;
class MeshDomain;
class MeshDomainAssoc;
class Instruction;
class MappingFunctionSet;
class TargetWriter;
class VertexSlaver;
class TagVertexMesh;

/*! \class InstructionQueue
  \brief An InstructionQueue object gathers Mesquite Instructions and ensures
         that the instruction queue is coherent for mesh improvement and/or
         mesh quality assessment purposes.

         The user can instantiate several InstructionQueue objects to be used
         with various MeshSet objects.

         The most commonly used functions are:
         -# add_preconditioner(...)
         -# add_quality_assessor(...)
         -# set_master_quality_improver(...)
         -# run_instructions(...)
*/
class InstructionQueue : public IQInterface
{

  public:
    MESQUITE_EXPORT
    InstructionQueue();

    MESQUITE_EXPORT
    InstructionQueue( const Settings& settings );

    MESQUITE_EXPORT
    virtual ~InstructionQueue();

    MESQUITE_EXPORT
    void add_target_calculator( TargetWriter* tc, MsqError& err );

    //! Add a tool mark higher-order nodes as slaved.
    //! Note:  Implies set_slaved_ho_node_mode( Settings::SLAVE_CALCULATED )
    MESQUITE_EXPORT
    void add_vertex_slaver( VertexSlaver* slaver, MsqError& err );
    //! Remove a tool mark higher-order nodes as slaved.
    //! Note:  Implies set_slaved_ho_node_mode( Settings::SLAVE_ALL )
    MESQUITE_EXPORT
    void remove_vertex_slaver( VertexSlaver* slaver, MsqError& err );

    MESQUITE_EXPORT
    void add_tag_vertex_mesh( TagVertexMesh* m, MsqError& err );
    MESQUITE_EXPORT
    void remove_tag_vertex_mesh( TagVertexMesh* m, MsqError& err );

    MESQUITE_EXPORT
    void add_preconditioner( QualityImprover* instr, MsqError& err );
    MESQUITE_EXPORT
    void remove_preconditioner( size_t index, MsqError& err );
    MESQUITE_EXPORT
    void insert_preconditioner( QualityImprover* instr, size_t index, MsqError& err );

    MESQUITE_EXPORT
    void add_quality_assessor( QualityAssessor* instr, MsqError& err );
    MESQUITE_EXPORT
    void remove_quality_assessor( size_t index, MsqError& err );
    MESQUITE_EXPORT
    void insert_quality_assessor( QualityAssessor* instr, size_t index, MsqError& err );

    MESQUITE_EXPORT
    void set_master_quality_improver( QualityImprover* instr, MsqError& err );

    MESQUITE_EXPORT
    void disable_automatic_quality_assessment()
    {
        autoQualAssess = false;
    }
    MESQUITE_EXPORT
    void enable_automatic_quality_assessment()
    {
        autoQualAssess = true;
    }

    /**\brief Exectute the instruction queue.
     *
     * Execute all operations in the instruction queue.
     *
     *\param mesh   The mesh to run each instruction on.
     *\param domain The domain of the mesh -- may be NULL if no domain.
     */
    MESQUITE_EXPORT
    virtual void run_common( MeshDomainAssoc* mesh_and_domain, ParallelMesh* pmesh, Settings* settings, MsqError& err );<--- Function in derived class

    MESQUITE_EXPORT
    void clear();

  protected:
  private:
    std::list< Instruction* >::iterator clear_master( MsqError& err );

    std::list< Instruction* > instructions;

    bool autoQualAssess;

    int vertexSlaverCount;
    size_t nbPreConditionners;
    bool isMasterSet;
    size_t masterInstrIndex;  //!< 0-based. Keeping an index instead of an iterator
                              //!< in case list is reallocated
};

}  // namespace MBMesquite

#endif  // InstructionQueue_hpp