One of the main new features in the Revit 2014 API is the possibility to make use of external services to redefine the algorithms used for certain MEP related calculations.
The recent listing of Revit 2014 API functionality and SDK samples points out that this is one of the highlights of the new API, and yet no sample using it has been published yet.
Let's rectify that right here and now.
Built-in External Services
Revit MEP 2014 makes use of the external services itself. The service implementations live in the MEPCalculation sub-folder of 'C:\Program Files\Autodesk\Revit 2014\AddIns'.
It contains the following add-in manifests and .NET assemblies, with the DLLs listed under the add-in manifests loading them:
A very similar structure was extracted and released in a pre-release API sample on the Revit beta site as an example of implementing a custom external service, but never made it into the final release.
Prompted and supported by our MEP expert Martin Schmid, I now took a look at that and adapted it to the current Revit 2014 API.
Here are the steps and results:
- The UserMepCalculation sample
- Concepts and Use Cases
- Migration of the pre-alpha version
- Test run
The UserMepCalculation Sample
The UserMepCalculation add-in is an external application implementing user-defined MEP calculation solver external services that override Revit’s default MEPCalculation solvers and reports listed above, in particular:
- System pressure loss report
- Straight segment calculation
- Fitting and accessory calculation
The UserMepCalculation Visual Studio solution contains the following four C# projects:
Concepts and Use Cases
Actually, digging in deeper, the sample addresses these six separate concepts:
- Pipe Segment Pressure Loss Calculation
- Pipe Fitting/Accessory Pressure Loss Calculation
- Pipe Fixture Units to Volume Flow conversion Calculation
- Duct Segment Pressure Loss Calculation
- Duct Fitting/Accessory Pressure Loss Calculation
- Pressure Loss Report
Migration of the Pre-alpha Version
Compiling the original pre-alpha version of this add-in produced the following initial list of 3 errors and 6 warnings.
I applied the disable architecture mismatch warning utility DisableMismatchWarning.exe, removing the warnings, leaving just 3 errors.
All three are similar, complaining that the three server implementations for pipe plumbing fixture flow and duct and pipe pressure drop, derived from the three interfaces IPipePressureDropServer, IDuctPressureDropServer and IPipePlumbingFixtureFlowServer, are not fulfilling their contract that requires them to implement the GetHtmlDescription member method.
Once the three methods were added, the compilation proceeded one step further and reported the next 4 errors, all referring to an erroneous call to an InnerDiameter method. That property was since renamed to InsideDiameter. After fixing that as well, the sample builds with zero errors and warnings.
It makes use of some unnecessary internal project settings that I cleaned up and removed as far as possible. Some remnants are still left, though. Among other things, the projects are set up to build specific 32 and 64 bit versions, although they are all identical, being standard .NET IL assemblies.
Once this was cleaned up, compiled and installed, it could be tested.
To use and test, build and install the add-in. Note that the new user defined alternate calculation methods are now available and can be selected via Manage > MEP Settings > Mechanical Settings > Duct Settings and Pipe Settings > Calculation.
User duct pressure drop:
User pipe pressure drop:
User plumbing fixture flow:
Let's examine a system pressure-loss report. Note that the project-defined user interface now appears after launching Analyze > Reports & Schedules > Pipe Pressure Loss Report.
I copied the default pressure loss report transformation PressureLossReport.xslt from the above-mentioned MEPCalculation folder and renamed it to UserPressureLossReport.xslt.
The standard Revit pressure loss command now picks up my redefined calculation rules and created this pressure loss report from the Revit MEP basic sample project rme_basic_sample_project.rvt.
Here is UserMepCalculation.zip containing the complete source code, Visual Studio solution, add-in manifest and some documentation on the custom calculation and report add-in.
I am off to Australia Sunday evening to hold a Revit API training there next week, and want to do some climbs in the Furka pass this weekend before leaving, so wish me luck!