/*****************************************************************************
*
* Copyright (c) 2000 - 2018, Lawrence Livermore National Security, LLC
* Produced at the Lawrence Livermore National Laboratory
* LLNL-CODE-442911
* All rights reserved.
*
* This file is  part of VisIt. For  details, see https://visit.llnl.gov/.  The
* full copyright notice is contained in the file COPYRIGHT located at the root
* of the VisIt distribution or at http://www.llnl.gov/visit/copyright.html.
*
* Redistribution  and  use  in  source  and  binary  forms,  with  or  without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of  source code must  retain the above  copyright notice,
*    this list of conditions and the disclaimer below.
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this  list of  conditions  and  the  disclaimer (as noted below)  in  the
*    documentation and/or other materials provided with the distribution.
*  - Neither the name of  the LLNS/LLNL nor the names of  its contributors may
*    be used to endorse or promote products derived from this software without
*    specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT  HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR  IMPLIED WARRANTIES, INCLUDING,  BUT NOT  LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND  FITNESS FOR A PARTICULAR  PURPOSE
* ARE  DISCLAIMED. IN  NO EVENT  SHALL LAWRENCE  LIVERMORE NATIONAL  SECURITY,
* LLC, THE  U.S.  DEPARTMENT OF  ENERGY  OR  CONTRIBUTORS BE  LIABLE  FOR  ANY
* DIRECT,  INDIRECT,   INCIDENTAL,   SPECIAL,   EXEMPLARY,  OR   CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT  LIMITED TO, PROCUREMENT OF  SUBSTITUTE GOODS OR
* SERVICES; LOSS OF  USE, DATA, OR PROFITS; OR  BUSINESS INTERRUPTION) HOWEVER
* CAUSED  AND  ON  ANY  THEORY  OF  LIABILITY,  WHETHER  IN  CONTRACT,  STRICT
* LIABILITY, OR TORT  (INCLUDING NEGLIGENCE OR OTHERWISE)  ARISING IN ANY  WAY
* OUT OF THE  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
*****************************************************************************/

// ************************************************************************* //
//  File: avtLagrangianFilter.h
// ************************************************************************* //

#ifndef AVT_Lagrangian_FILTER_H
#define AVT_Lagrangian_FILTER_H

#include <avtPICSFilter.h>
#include <avtPluginFilter.h>

#include <LagrangianAttributes.h>


class vtkDataSet;


// ****************************************************************************
//  Class: avtLagrangianFilter
//
//  Purpose:
//      A plugin operator for Lagrangian.
//
//  Programmer: pugmire -- generated by xml2avt
//  Creation:   Wed Mar 7 14:22:35 PST 2012
//
// ****************************************************************************

class avtLagrangianFilter : public avtPluginFilter,
                            public avtPICSFilter
{
  public:
                         avtLagrangianFilter();
    virtual             ~avtLagrangianFilter();

    static avtFilter    *Create();

    virtual const char  *GetType(void)  { return "avtLagrangianFilter"; };
    virtual const char  *GetDescription(void)
                             { return "Lagrangian"; };

    virtual void         SetAtts(const AttributeGroup*);
    virtual bool         Equivalent(const AttributeGroup*);

    virtual avtContract_p   ModifyContract(avtContract_p);
    virtual void            UpdateDataObjectInfo(void);

    virtual void            CreateIntegralCurveOutput(std::vector<avtIntegralCurve *> &);
    virtual avtIntegralCurve* CreateIntegralCurve();
    virtual avtIntegralCurve* CreateIntegralCurve(const avtIVPSolver*, avtIntegralCurve::Direction, const double&, const avtVector&, const avtVector&, long int);
    virtual bool              GetAllSeedsSentToAllProcs() { return true; };

    virtual std::vector<avtVector> GetInitialLocations();
    virtual std::vector<avtVector> GetInitialVelocities()
                          { return std::vector<avtVector>(); };
    virtual CommunicationPattern GetCommunicationPattern() 
                          { return ReturnToOriginatingProcessor; };

    virtual avtIVPField* GetFieldForDomain(const BlockIDType& dom,
                                           vtkDataSet* ds);

  protected:
    LagrangianAttributes   atts;
    std::string        outVarName;
};


#endif
