FV3 Bundle
PostProcessor.h
Go to the documentation of this file.
1 /*
2  * (C) Copyright 2009-2016 ECMWF.
3  *
4  * This software is licensed under the terms of the Apache Licence Version 2.0
5  * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
6  * In applying this licence, ECMWF does not waive the privileges and immunities
7  * granted to it by virtue of its status as an intergovernmental organisation nor
8  * does it submit to any jurisdiction.
9  */
10 
11 #ifndef OOPS_BASE_POSTPROCESSOR_H_
12 #define OOPS_BASE_POSTPROCESSOR_H_
13 
14 #include <vector>
15 
16 #include <boost/foreach.hpp>
17 #include <boost/shared_ptr.hpp>
18 
19 #include "oops/base/PostBase.h"
20 
21 namespace oops {
22 
23 /// Control model post processing
24 /*!
25  * This class controls model post processing in the most general sense,
26  * ie all diagnostics computations that do not affect the model integration.
27  * It just calls all the individual processors one by one.
28  */
29 
30 template<typename FLDS>
33 
34  public:
38 
40  if (pp != 0) {
41  boost::shared_ptr<PostBase_> sp(pp);
42  processors_.push_back(sp);
43  }
44  }
45 
46  void enrollProcessor(boost::shared_ptr<PostBase_> pp) {
47  if (pp != 0) processors_.push_back(pp);
48  }
49 
50  void initialize(const FLDS & xx, const util::DateTime & end,
51  const util::Duration & step) {
52  BOOST_FOREACH(boost::shared_ptr<PostBase_> jp, processors_)
53  jp->initialize(xx, end, step);
54  }
55 
56  void process(const FLDS & xx) {
57  BOOST_FOREACH(boost::shared_ptr<PostBase_> jp, processors_) jp->process(xx);
58  }
59 
60  void finalize(const FLDS & xx) {
61  BOOST_FOREACH(boost::shared_ptr<PostBase_> jp, processors_) jp->finalize(xx);
62  }
63 
64  private:
65  std::vector< boost::shared_ptr<PostBase_> > processors_;
67 };
68 
69 } // namespace oops
70 
71 #endif // OOPS_BASE_POSTPROCESSOR_H_
real(r8), dimension(cast_m, cast_n) sp
~PostProcessor()
Definition: PostProcessor.h:37
************************************************************************GNU Lesser General Public License **This file is part of the GFDL Flexible Modeling System(FMS). ! *! *FMS is free software without even the implied warranty of MERCHANTABILITY or *FITNESS FOR A PARTICULAR PURPOSE See the GNU General Public License *for more details **You should have received a copy of the GNU Lesser General Public *License along with FMS If see< http:! ***********************************************************************!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! MPP_TRANSMIT !! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! subroutine MPP_TRANSMIT_(put_data, put_len, to_pe, get_data, get_len, from_pe, block, tag, recv_request, send_request)!a message-passing routine intended to be reminiscent equally of both MPI and SHMEM!put_data and get_data are contiguous MPP_TYPE_ arrays!at each call, your put_data array is put to to_pe 's get_data! your get_data array is got from from_pe 's put_data!i.e we assume that typically(e.g updating halo regions) each PE performs a put _and_ a get!special PE designations:! NULL_PE:to disable a put or a get(e.g at boundaries)! ANY_PE:if remote PE for the put or get is to be unspecific! ALL_PES:broadcast and collect operations(collect not yet implemented)!ideally we would not pass length, but this f77-style call performs better(arrays passed by address, not descriptor)!further, this permits< length > contiguous words from an array of any rank to be passed(avoiding f90 rank conformance check)!caller is responsible for completion checks(mpp_sync_self) before and after integer, intent(in) ::put_len, to_pe, get_len, from_pe MPP_TYPE_, intent(in) ::put_data(*) MPP_TYPE_, intent(out) ::get_data(*) logical, intent(in), optional ::block integer, intent(in), optional ::tag integer, intent(out), optional ::recv_request, send_request logical ::block_comm integer ::i MPP_TYPE_, allocatable, save ::local_data(:) !local copy used by non-parallel code(no SHMEM or MPI) integer ::comm_tag integer ::rsize if(.NOT.module_is_initialized) call mpp_error(FATAL, 'MPP_TRANSMIT:You must first call mpp_init.') if(to_pe.EQ.NULL_PE .AND. from_pe.EQ.NULL_PE) return block_comm=.true. if(PRESENT(block)) block_comm=block if(debug) then call SYSTEM_CLOCK(tick) write(stdout_unit,'(a, i18, a, i6, a, 2i6, 2i8)')&'T=', tick, ' PE=', pe, ' MPP_TRANSMIT begin:to_pe, from_pe, put_len, get_len=', to_pe, from_pe, put_len, get_len end if comm_tag=DEFAULT_TAG if(present(tag)) comm_tag=tag!do put first and then get if(to_pe.GE.0 .AND. to_pe.LT.npes) then!use non-blocking sends if(debug .and.(current_clock.NE.0)) call SYSTEM_CLOCK(start_tick)!z1l:truly non-blocking send.! if(request(to_pe).NE.MPI_REQUEST_NULL) then !only one message from pe-> to_pe in queue *PE waiting for to_pe ! call error else get_len so only do gets but you cannot have a pure get with MPI call a get means do a wait to ensure put on remote PE is complete error call increase mpp_nml request_multiply call MPP_TRANSMIT end
void enrollProcessor(boost::shared_ptr< PostBase_ > pp)
Definition: PostProcessor.h:46
PostProcessor(const PostProcessor &pp)
Definition: PostProcessor.h:36
Handles post-processing of model fields.
Definition: PostBase.h:33
The namespace for the main oops code.
std::vector< boost::shared_ptr< PostBase_ > > processors_
Definition: PostProcessor.h:65
PostProcessor()
Definition: PostProcessor.h:35
void finalize(const FLDS &xx)
Definition: PostProcessor.h:60
void process(const FLDS &xx)
Definition: PostProcessor.h:56
subroutine, public step(x, g)
Control model post processing.
Definition: PostProcessor.h:31
void initialize(const FLDS &xx, const util::DateTime &end, const util::Duration &step)
Definition: PostProcessor.h:50
void enrollProcessor(PostBase_ *pp)
Definition: PostProcessor.h:39
PostBase< FLDS > PostBase_
Definition: PostProcessor.h:32
PostProcessor operator=(const PostProcessor &)