IterationControl.h

Go to the documentation of this file.

/* -*- mode: c++ -*- */
//# IterationControl.h: Iteration control for parallel imaging framework
//#                     (ParallelImagerMixin)
//# Copyright (C) 2016
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 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 Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//#        Internet email: aips2-request@nrao.edu.
//#        Postal address: AIPS++ Project Office
//#                        National Radio Astronomy Observatory
//#                        520 Edgemont Road
//#                        Charlottesville, VA 22903-2475 USA
//#
#ifndef ITERATION_CONTROL_H_
#define ITERATION_CONTROL_H_

#include <casa/Containers/Record.h>
#include <synthesis/ImagerObjects/MPIGlue.h>
#include <synthesis/ImagerObjects/DistributedSynthesisIterBot.h>
#include <synthesis/ImagerObjects/ParallelImager.h>

#include <memory>

namespace casa {

class IterationControl {

private:
        std::unique_ptr<DistributedSynthesisIterBot> it;

protected:
        void
        setup_iteration_controller(MPI_Comm comm, Record &iter_pars) {
                teardown_iteration_controller();
                // Instantiate an iterbot. Use DistributedSynthesisIterBot when
                // interaction with new GUI works; for now,
                // DistributedSynthesisIterBotWithOldGUI works.
                it = std::unique_ptr<DistributedSynthesisIterBot>(
                        new DistributedSynthesisIterBotWithOldGUI(comm));
                it->setupIteration(iter_pars);
        };

        void
        teardown_iteration_controller() {
                it.reset();
        }

public:
        void
        end_major_cycle() {
                it->endMajorCycle();
        };

        Record
        get_minor_cycle_controls() {
                return it->getSubIterBot();
        };

        void
        merge_execution_records(const Vector<Record> &recs) {
                it->endMinorCycle(recs);
        };

        void
        merge_initialization_records(const Vector<Record> &recs) {
                it->startMinorCycle(recs);
        };

        bool
        is_clean_complete() {
                return it->cleanComplete() > 0;
        };

        Record
        get_summary() {
                return it->getIterationSummary();
        };

        static int effective_rank(MPI_Comm comm) {
                int result;
                if (comm != MPI_COMM_NULL)
                        MPI_Comm_rank(comm, &result);
                else
                        result = -1;
                return result;
        }

        static int effective_size(MPI_Comm comm) {
                int result;
                if (comm != MPI_COMM_NULL)
                        MPI_Comm_size(comm, &result);
                else
                        result = 0;
                return result;
        }
};

} // namespace casa

#endif // ITERATION_CONTROL_H_