FV3 Bundle
ObsSpaceBase.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_INTERFACE_OBSSPACEBASE_H_
12 #define OOPS_INTERFACE_OBSSPACEBASE_H_
13 
14 #include <boost/noncopyable.hpp>
15 #include "eckit/config/LocalConfiguration.h"
16 
17 #include "oops/util/DateTime.h"
18 #include "oops/util/Printable.h"
19 
20 namespace oops {
21 
22 // -----------------------------------------------------------------------------
23 /// Base class for observation spaces.
24 
25 class ObsSpaceBase : public util::Printable,
26  private boost::noncopyable {
27  public:
28  ObsSpaceBase(const eckit::Configuration & config,
29  const util::DateTime & bgn, const util::DateTime & end)
30  : conf_(config), winbgn_(bgn), winend_(end) {}
31  virtual ~ObsSpaceBase() {}
32 
33 /// Access information
34  const eckit::Configuration & config() const {return conf_;}
35  const util::DateTime & windowStart() const {return winbgn_;}
36  const util::DateTime & windowEnd() const {return winend_;}
37 
38 /// Pure virtual methods
39  virtual void generateDistribution(const eckit::Configuration &) = 0;
40 
41  private:
42  const eckit::LocalConfiguration conf_;
43  const util::DateTime winbgn_;
44  const util::DateTime winend_;
45 };
46 
47 } // namespace oops
48 
49 #endif // OOPS_INTERFACE_OBSSPACEBASE_H_
const util::DateTime winbgn_
Definition: ObsSpaceBase.h:43
const eckit::LocalConfiguration conf_
Definition: ObsSpaceBase.h:42
virtual void generateDistribution(const eckit::Configuration &)=0
Pure virtual methods.
ObsSpaceBase(const eckit::Configuration &config, const util::DateTime &bgn, const util::DateTime &end)
Definition: ObsSpaceBase.h:28
************************************************************************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
virtual ~ObsSpaceBase()
Definition: ObsSpaceBase.h:31
The namespace for the main oops code.
const util::DateTime & windowStart() const
Definition: ObsSpaceBase.h:35
Base class for observation spaces.
Definition: ObsSpaceBase.h:25
const util::DateTime & windowEnd() const
Definition: ObsSpaceBase.h:36
const util::DateTime winend_
Definition: ObsSpaceBase.h:44
const eckit::Configuration & config() const
Access information.
Definition: ObsSpaceBase.h:34